Skip to main content

API

The DPhi API powers the dashboard and enables programmatic control of namespaces, operations, executions, and files. Use it to automate workflows or integrate DPhi systems with your tooling.

Authentication​

The API uses bearer tokens. Exchange a username and password for an access token, then include it on subsequent requests:

Authorization: Bearer <access-token>

Tokens are short-lived; when they expire, re-authenticate to obtain a new access token.

API specification​

The OpenAPI definition is available at:

https://cg2.dphispace.com/api/specs

You can download the YAML and load it into Swagger or any OpenAPI-compatible tool to explore the endpoints and schemas.

Delete semantics​

The API uses soft deletes for namespaces, operations, executions, and ground namespace files. In practice, delete endpoints usually mark records as deleted and filter them out of default reads instead of physically removing them.

Some endpoints let you include soft-deleted records by passing allowDeleted=true. This is supported for operation and execution reads.

Current behavior to expect:

  • Deleting an execution soft-deletes the execution only.
  • Deleting an operation soft-deletes the targeted operation revision or revisions and also soft-deletes linked executions in the same tenant and namespace.
  • Deleting an operation or execution does not soft-delete usage metric documents, so quota totals still include that usage.
  • Deleting a namespace soft-deletes the namespace plus its namespace-scoped operations, executions, and ground file metadata.
  • Deleting a namespace does not soft-delete usage metric documents, so quota totals still include that namespace's historical usage.
  • Namespace file deletes soft-delete metadata and keep stored file revisions in backing storage.