DigitalOcean

DigitalOcean API

Status of all DigitalOcean services

Developer tools#development

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Status of all DigitalOcean services

Endpoints 400

1-Click Applications

  • GETList 1-Click Applications/v2/1-clicksTo list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a…
  • POSTInstall Kubernetes 1-Click Applications/v2/1-clicks/kubernetesTo install a Kubernetes 1-Click application on a cluster, send a POST request to /v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as…

Account

  • GETGet User Information/v2/accountTo show information about the current user account, send a GET request to /v2/account.

Actions

  • GETList All Actions/v2/actionsThis will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will…
  • GETRetrieve an Existing Action/v2/actions/:action_idTo retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.

Add-Ons

  • GETList Available Add-On Applications/v2/add-ons/appsTo fetch details of all available Add-On Applications, send a GET request to /v2/add-ons/apps.
  • GETGet Metadata for an Add-On Application/v2/add-ons/apps/:app_slug/metadataTo find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata. Metadata varies by application.
  • GETList all Add-On Resources/v2/add-ons/saasTo fetch all Add-On Resources under your team, send a GET request to /v2/add-ons/saas.
  • POSTCreate/Provision a New Add-on Resource/v2/add-ons/saasTo create an add-on resource, send a POST request to /v2/add-ons/saas with required parameters. Some add-ons require additional metadata to be provided in the…
  • GETGet details on an Add-On Resource/v2/add-ons/saas/:resource_uuidTo fetch details of a specific Add-On Resource, send a GET request to /v2/add-ons/saas/{resource_uuid}. Replace {resource_uuid} with the UUID of the resource…
  • DELETEDelete/Deprovision an Add-on Resource/v2/add-ons/saas/:resource_uuidTo delete an add-on resource, send a DELETE request to /v2/add-ons/saas/{resource_uuid} with the UUID of the resource to delete. You cannot retrieve the…
  • PATCHUpdate the name for an Add-On Resource/v2/add-ons/saas/:resource_uuidTo change the name of an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource_uuid}. Replace {resource_uuid} with the UUID of the resource for…
  • PATCHUpdate the plan for an Add-On Resource/v2/add-ons/saas/:resource_uuid/planTo change the plan associated with an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource_uuid}/plan. Replace {resource_uuid} with the UUID of…

Action Gateway

  • GETGet an Actor's Limits/v2/action-gateway/actors/:actor_id/limitsReturns the per-minute limits set for the actor and the limits in effect, each the lower of your team's limit and the actor's override. Returns 404 when the…
  • POSTClear an Actor's Limits/v2/action-gateway/actors/:actor_id/limits:clearRemoves the actor's overrides for the listed categories, which then follow your team's limits again. Clearing a category without an override succeeds.
  • POSTSet an Actor's Limits/v2/action-gateway/actors/:actor_id/limits:setSets per-minute limits for the listed categories and leaves the others unchanged. A limit may not exceed your team's current limit for the category (400…
  • GETList Provider Credentials/v2/action-gateway/provider-credentialsLists registered credentials visible to you, ordered by provider and display name. Optionally filter by provider slug, ignoring case. An unknown provider…
  • POSTCreate a Provider Credential/v2/action-gateway/provider-credentialsStores an API key or OAuth client for a catalog provider that supports that credential type. Secret material is write-only. Only you can see and use the…
  • GETGet a Provider Credential/v2/action-gateway/provider-credentials/:idReturns metadata for a provider credential, never its secret material. Returns 404 if the credential is unknown, deleted, or not visible to you.
  • DELETEDelete a Provider Credential/v2/action-gateway/provider-credentials/:idDeletes a provider credential and every connection that uses it. There is no confirmation step. Warn affected users before deleting; sessions relying on those…
  • PATCHUpdate a Provider Credential/v2/action-gateway/provider-credentials/:idRotates an API key or OAuth client secret, or updates credential metadata, in place. Send only the fields to change; omitted fields are preserved. No update…
  • GETList Connections/v2/action-gateway/connectionsReturns the connections you can see, excluding revoked ones. Offset-paged with page and per_page; filter by provider, user_id, and status.
  • POSTCreate a Connection/v2/action-gateway/connectionsConnects one of your users, identified by user_id, to a provider so tools can act on their account. An OAuth connection starts pending, and authorization…
  • GETGet a Connection/v2/action-gateway/connections/:idReturns the connection and, while it is pending, the authorization the user still has to complete. Reading a pending connection picks up a completed…
  • DELETEDelete a Connection/v2/action-gateway/connections/:idMarks the connection revoked and returns it; for an OAuth connection, its stored tokens are deleted first. Creating a connection for the same provider and…
  • GETList MCP Servers/v2/action-gateway/mcp-serversReturns every MCP server your team has registered, sorted by serverRef.
  • POSTRegister an MCP Server/v2/action-gateway/mcp-serversRegisters a remote MCP server for your team, using the streamable HTTP transport. The server starts with syncStatus pending and no tools: discover its tools…
  • GETGet an MCP Server/v2/action-gateway/mcp-servers/:server_refReturns one of your team's MCP servers, or 404 when your team has none with this serverRef.
  • DELETEDelete an MCP Server/v2/action-gateway/mcp-servers/:server_refDisables all of the server's tools, removes them from your team's catalog, and deletes the server. An api_key supplied at registration is deleted; a…
  • PATCHUpdate an MCP Server/v2/action-gateway/mcp-servers/:server_refChanges the server's description, which is shown on its catalog card immediately. The endpoint and credentials cannot be changed; to change them, delete the…
  • POSTDiscover an MCP Server's Tools/v2/action-gateway/mcp-servers/:server_ref/resyncConnects to the server, lists its tools, and records them. Discovered tools are not callable until you enable them. When discovery finishes in time, returns…
  • GETList an MCP Server's Tools/v2/action-gateway/mcp-servers/:server_ref/toolsReturns every tool discovered on the server, sorted by name, with whether each is enabled. Tools that have since disappeared from the server stay listed.
  • PUTSet Which of an MCP Server's Tools Are Enabled/v2/action-gateway/mcp-servers/:server_ref/toolsenabledToolSlugs is the complete set to enable; every other tool of the server is disabled. An enabled tool is added to your team's catalog at its latest…
  • GETList Output Views/v2/action-gateway/output-viewsReturns the output views your team can use: views DigitalOcean publishes to every team, plus your team's own. Cursor-paged with page_size and page_token; no…
  • POSTCreate an Output View/v2/action-gateway/output-viewsAn output view is a named projection of one tool version's output: tool calls that use it return only the listed fields, and its output_schema describes the…
  • POSTPreview an Output View/v2/action-gateway/output-views/previewValidates a projection exactly as create does and returns the view it would produce, including output_schema, without storing anything. name and description…
  • GETGet an Output View/v2/action-gateway/output-views/:view_idReturns one of your team's views, or a published view on a tool version your catalog exposes. Returns 404 when the view does not exist, was deleted, or…
  • DELETEDelete an Output View/v2/action-gateway/output-views/:view_idDeletes one of your team's views and returns it with audit.deleted_at set; it can no longer be used. Published views cannot be deleted. Returns 404 when the…
  • GETList Endpoints/v2/action-gateway/endpointsLists visible endpoints, newest creation time first, with endpoint UUID descending as the tie-breaker. Keyset pagination remains stable across tied…
  • POSTCreate an Endpoint/v2/action-gateway/endpointsCreates a named endpoint and its first immutable version atomically. The MCP URL follows the highest-numbered live version; version_mcp_url stays pinned. The…
  • GETSearch Endpoints/v2/action-gateway/endpoints/search?query=supportReturns the endpoints you can see whose name, endpoint ID, actor_id, or agent name contains query, case-insensitively. Results are ranked across the whole…
  • GETRetrieve an Endpoint/v2/action-gateway/endpoints/:endpoint_idReturns an endpoint with its live head and Insights consent. When no live versions remain, head_version is null and the endpoint MCP URL fails closed until a…
  • DELETEDelete an Endpoint/v2/action-gateway/endpoints/:endpoint_idDeletes an endpoint and all its versions. The owner or a team owner may delete it. Missing endpoints, endpoints outside your team, and otherwise invisible…
  • PATCHUpdate an Endpoint/v2/action-gateway/endpoints/:endpoint_idRenames an endpoint, changes its Insights consent, or both, without changing its owner, actor, or versions. Send name, insights, or both. Insights merges per…
  • GETList Endpoint Versions/v2/action-gateway/endpoints/:endpoint_id/versionsLists live versions of an accessible endpoint by version_number descending, using keyset pagination without offsets or totals. The cursor is bound to this…
  • POSTCreate an Endpoint Version/v2/action-gateway/endpoints/:endpoint_id/versionsPublishes a new immutable version as the endpoint's head. Only the endpoint owner may create versions, and the actor binding must match the endpoint. An…
  • POSTPromote an Endpoint Version/v2/action-gateway/endpoints/:endpoint_id/versions:promoteCopies a live version's configuration into a new, higher-numbered head version and sets promoted_from_version_number. Existing versions never change. Only the…
  • GETRetrieve an Endpoint Version/v2/action-gateway/endpoint-versions/:version_idReturns the exact live version named by its composite public ID. An inaccessible or deleted version returns 404 endpoint_version_not_found. A bare session…
  • DELETEDelete an Endpoint Version/v2/action-gateway/endpoint-versions/:version_idDeletes a live version. Only the endpoint owner may delete versions. Deleting the head makes the highest-numbered remaining live version the head. With no…
  • GETList Sessions/v2/action-gateway/sessionsDeprecated. Deprecated: use GET /v2/action-gateway/endpoints for endpoints. This route continues to list legacy sessions with its existing fields and…
  • POSTCreate a Session/v2/action-gateway/sessionsDeprecated. Deprecated: use POST /v2/action-gateway/endpoints. Existing sessions and their MCP URLs keep working. A new session may be created as version 1 of…
  • GETSearch Sessions/v2/action-gateway/sessions/searchDeprecated. Deprecated: use GET /v2/action-gateway/endpoints/search for endpoints. This route continues to search legacy sessions with its existing fields and…
  • DELETEDelete a Session/v2/action-gateway/sessions/:session_urnDeprecated. Deprecated: use DELETE /v2/action-gateway/endpoints/{endpoint_id} for endpoints. This route continues to accept legacy session URNs and delete…
  • GETList Toolbelts/v2/action-gateway/toolbeltsReturns your team's toolbelts, one entry per name describing its latest version, sorted by name. Offset-paged with page and per_page; pagination reports the…
  • POSTCreate a Toolbelt/v2/action-gateway/toolbeltsA toolbelt is a named set of tools, each pinned to a version, that your team can attach to sessions as toolbelt:<name>@<version>. The first version is 1…
  • GETSearch Toolbelts/v2/action-gateway/toolbelts/searchReturns your team's toolbelts whose name, display name, or description contains query, case-insensitively, sorted by name. Cursor-paged with page_size and…
  • GETGet a Toolbelt/v2/action-gateway/toolbelts/:nameReturns the latest version of the named toolbelt, or the version requested, with catalog metadata for one page of its members in tool_details. A deleted…
  • DELETEDelete a Toolbelt/v2/action-gateway/toolbelts/:nameMarks the toolbelt deleted and returns its latest version with status deprecated. Its versions stay readable by explicit version until the name is reused. The…
  • GETList the Providers in a Toolbelt/v2/action-gateway/toolbelts/:name/providersReturns the distinct providers of the toolbelt's members, each with its member count, sorted by provider ID. List one provider's members with GET…
  • GETList a Toolbelt's Tools from One Provider/v2/action-gateway/toolbelts/:name/providers/:provider/toolsReturns a page of catalog metadata for the toolbelt's members from the named provider, sorted by tool slug. An unknown provider returns an empty page.
  • POSTAdd Tools to a Toolbelt/v2/action-gateway/toolbelts/:name/tools/addAdds the listed tools and returns the toolbelt. When membership changes, this creates a new version that keeps the display name and description. Tools already…
  • POSTRemove Tools from a Toolbelt/v2/action-gateway/toolbelts/:name/tools/removeRemoves the listed tools and returns the toolbelt. When membership changes, this creates a new version that keeps the display name and description. Tools that…
  • GETList Tools/v2/action-gateway/toolsReturns one page of the tools your team can use: released catalog tools plus the enabled tools of your team's MCP servers. definitions[i] describes tools[i].…
  • GETList Tool Health/v2/action-gateway/tools/healthReturns availability and latency for each catalog tool over the requested window, sorted by provider and then tool slug. A tool with no calls in the window is…
  • GETList Provider Health/v2/action-gateway/tools/health/providersReturns availability and latency for each catalog provider over the requested window, sorted by provider ID. Metrics are aggregated across all customers;…
  • GETGet Tool Health/v2/action-gateway/tools/health/tools/:tool_slugReturns availability and latency for one catalog tool over the requested window, optionally with a history series. Metrics are aggregated across all…
  • GETList Providers/v2/action-gateway/tools/providersReturns the active catalog providers with at least one released tool, sorted by display name, with the credential kinds each accepts and the parameters a…
  • GETSearch Providers/v2/action-gateway/tools/providers/searchReturns the providers of GET /v2/action-gateway/tools/providers whose name, display name, or description contains query, case-insensitively, sorted by name.…
  • GETSearch Tools/v2/action-gateway/tools/searchReturns the tools your team can use that match query, optionally restricted to some providers or to the members of one of your toolbelts. Results are ranked…
  • GETList Toolkits/v2/action-gateway/tools/toolkitsReturns the providers (toolkits) whose tools your team can use: catalog providers with at least one released tool, plus your team's registered MCP servers.
  • GETList Users/v2/action-gateway/usersReturns the user IDs known for your team: session actor_id values, the user_id of connections that are not revoked, and actors with limit overrides. Only…
  • GETGet a User/v2/action-gateway/users/:user_idReturns the sessions and non-revoked connections of one user ID. Returns 404 when the user has none you can see and no limit overrides.

Action Gateway Data Plane

  • GETList Session Toolshttps://actions.do-ai.run/toolsLists the catalog tools that a session can call, ordered by name. The list applies the session's tools selection and omits tools that its policy always…
  • POSTSearch Session Toolshttps://actions.do-ai.run/tools/searchFinds the catalog tools that fit one or more use cases. This is the REST form of the action_search MCP tool. Each query is searched independently and returns…
  • POSTInvoke Session Toolshttps://actions.do-ai.run/tools/invokeRuns 1 to 10 tool calls in parallel and returns one result per call, in request order. This is the REST form of the action_invoke MCP tool. Each call is…
  • POSTExecute Codehttps://actions.do-ai.run/code/executeRuns Python code in an ephemeral sandbox and returns its stdout, stderr, and exit_code. This is the REST form of the action_code MCP tool. Use it for…
  • POSTDecide a Pending Approvalhttps://actions.do-ai.run/approvals/session/:session_id/:approval_idApproves or denies a tool call that is waiting for approval. A tool result returns _meta.status set to requires_approval when the session policy sets ask for…
  • POSTDecide a Pending Approval by Session Headerhttps://actions.do-ai.run/approvals/:approval_idApproves or denies a tool call that is waiting for approval, identifying the session with the X-Session-Id header or the endpoint with the X-Endpoint-Id…

Agent Platform API

  • GETList Agents/v2/gen-ai/agentsTo list all agents, send a GET request to /v2/gen-ai/agents.
  • POSTCreate an Agent/v2/gen-ai/agentsTo create a new agent, send a POST request to /v2/gen-ai/agents. The response body contains a JSON object with the newly created agent object.
  • GETList Agent API Keys/v2/gen-ai/agents/:agent_uuid/api_keysTo list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
  • POSTCreate an Agent API Key/v2/gen-ai/agents/:agent_uuid/api_keysTo create an agent API key, send a POST request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
  • PUTUpdate API Key for an Agent/v2/gen-ai/agents/:agent_uuid/api_keys/:api_key_uuidTo update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
  • DELETEDelete API Key for an Agent /v2/gen-ai/agents/:agent_uuid/api_keys/:api_key_uuidTo delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
  • PUTRegenerate API Key for an Agent/v2/gen-ai/agents/:agent_uuid/api_keys/:api_key_uuid/regenerateTo regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate.
  • POSTAdd Function Route to an Agent/v2/gen-ai/agents/:agent_uuid/functionsTo create a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/functions.
  • PUTUpdate Function Route for an Agent/v2/gen-ai/agents/:agent_uuid/functions/:function_uuidTo update the function route, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.
  • DELETEDelete Function Route for an Agent/v2/gen-ai/agents/:agent_uuid/functions/:function_uuidTo delete a function route from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.
  • POSTAttach Guardrails to an Agent/v2/gen-ai/agents/:agent_uuid/guardrailsTo attach guardrails to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/guardrails.
  • DELETEDetach a Guardrail from an Agent/v2/gen-ai/agents/:agent_uuid/guardrails/:guardrail_uuidTo detach a guardrail from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}.
  • POSTAttach Knowledge Bases to an Agent/v2/gen-ai/agents/:agent_uuid/knowledge_basesTo attach knowledge bases to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases
  • POSTAttach Knowledge Base to an Agent/v2/gen-ai/agents/:agent_uuid/knowledge_bases/:knowledge_base_uuidTo attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
  • DELETEDetach Knowledge Base from an Agent/v2/gen-ai/agents/:agent_uuid/knowledge_bases/:knowledge_base_uuidTo detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}.
  • PUTUpdate Agent Route for an Agent/v2/gen-ai/agents/:parent_agent_uuid/child_agents/:child_agent_uuidTo update an agent route for an agent, send a PUT request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
  • POSTAdd Agent Route to an Agent/v2/gen-ai/agents/:parent_agent_uuid/child_agents/:child_agent_uuidTo add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
  • DELETEDelete Agent Route for an Agent/v2/gen-ai/agents/:parent_agent_uuid/child_agents/:child_agent_uuidTo delete an agent route from a parent agent, send a DELETE request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
  • GETRetrieve an Existing Agent/v2/gen-ai/agents/:uuidTo retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.
  • PUTUpdate an Agent/v2/gen-ai/agents/:uuidTo update an agent, send a PUT request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.
  • DELETEDelete an Agent/v2/gen-ai/agents/:uuidTo delete an agent, send a DELETE request to /v2/gen-ai/agents/{uuid}.
  • GETView Agent Routes/v2/gen-ai/agents/:uuid/child_agentsTo view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child_agents.
  • PUTUpdate Agent Status/v2/gen-ai/agents/:uuid/deployment_visibilityCheck whether an agent is public or private. To update the agent status, send a PUT request to /v2/gen-ai/agents/{uuid}/deployment_visibility.
  • GETGet Agent Usage/v2/gen-ai/agents/:uuid/usageTo get agent usage, send a GET request to /v2/gen-ai/agents/{uuid}/usage. Returns usage metrics for the specified agent within the provided time range.
  • GETList Agent Versions/v2/gen-ai/agents/:uuid/versionsTo list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.
  • PUTRollback to Agent Version/v2/gen-ai/agents/:uuid/versionsTo update to a specific agent version, send a PUT request to /v2/gen-ai/agents/{uuid}/versions.
  • GETList Anthropic API Keys/v2/gen-ai/anthropic/keysTo list all Anthropic API keys, send a GET request to /v2/gen-ai/anthropic/keys.
  • POSTCreate Anthropic API Key/v2/gen-ai/anthropic/keysTo create an Anthropic API key, send a POST request to /v2/gen-ai/anthropic/keys.
  • GETGet Anthropic API Key/v2/gen-ai/anthropic/keys/:api_key_uuidTo retrieve details of an Anthropic API key, send a GET request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
  • PUTUpdate Anthropic API Key/v2/gen-ai/anthropic/keys/:api_key_uuidTo update an Anthropic API key, send a PUT request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
  • DELETEDelete Anthropic API Key/v2/gen-ai/anthropic/keys/:api_key_uuidTo delete an Anthropic API key, send a DELETE request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
  • GETList agents by Anthropic key/v2/gen-ai/anthropic/keys/:uuid/agentsList Agents by Anthropic Key.
  • GETList Custom Models/v2/gen-ai/custom_modelsTo list custom models, send a GET request to /v2/gen-ai/custom_models.
  • POSTImport Custom Model/v2/gen-ai/custom_models/importTo import a custom model, send a POST request to /v2/gen-ai/custom_models/import.
  • GETGet Custom Model/v2/gen-ai/custom_models/:uuidTo retrieve details of a custom model, send a GET request to /v2/gen-ai/custom_models/{uuid}.
  • DELETEDelete Custom Model/v2/gen-ai/custom_models/:uuidTo delete a custom model, send a DELETE request to /v2/genai/custom_models/{uuid}.
  • PATCHUpdate Custom Model Metadata/v2/gen-ai/custom_models/:uuid/metadataTo update custom model metadata, send a PATCH request to /v2/gen-ai/custom_models/{uuid}/metadata.
  • GETList Evaluation Datasets/v2/gen-ai/evaluation_datasetsTo list evaluation datasets, send a GET request to /v2/gen-ai/evaluation_datasets.
  • POSTCreate Evaluation Dataset/v2/gen-ai/evaluation_datasetsTo create an evaluation dataset, send a POST request to /v2/gen-ai/evaluation_datasets.
  • POSTCreate Presigned URLs for Evaluation Dataset File Upload/v2/gen-ai/evaluation_datasets/file_upload_presigned_urlsTo create presigned URLs for evaluation dataset file upload, send a POST request to /v2/gen-ai/evaluation_datasets/file_upload_presigned_urls.
  • DELETEDelete Evaluation Dataset/v2/gen-ai/evaluation_datasets/:dataset_uuidTo delete an evaluation dataset, send a DELETE request to /v2/genai/evaluation_datasets/{dataset_uuid}. This works for both model and agent evaluation datasets.
  • GETGet Download URL for Evaluation Dataset/v2/gen-ai/evaluation_datasets/:dataset_uuid/download_urlTo get a presigned download URL for an evaluation dataset, send a GET request to /v2/genai/evaluation_datasets/{dataset_uuid}/download_url.
  • GETList Evaluation Metrics/v2/gen-ai/evaluation_metricsTo list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics.
  • POSTCreate Custom Evaluation Metric/v2/gen-ai/custom_evaluation_metricsTo create a custom LLM-as-judge metric for model evaluation, send a POST request to /v2/gen-ai/custom_evaluation_metrics.
  • PUTUpdate Custom Evaluation Metric/v2/gen-ai/custom_evaluation_metrics/:metric_uuidTo update a custom metric (issuing a new metric UUID), send a PUT request to /v2/gen-ai/custom_evaluation_metrics/{metric_uuid}.
  • DELETEDelete Custom Evaluation Metric/v2/gen-ai/custom_evaluation_metrics/:metric_uuidTo soft-delete a custom model evaluation metric, send a DELETE request to /v2/gen-ai/custom_evaluation_metrics/{metric_uuid}.
  • POSTRun an Evaluation Test Case/v2/gen-ai/evaluation_runsTo run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.
  • GETRetrieve Information About an Existing Evaluation Run/v2/gen-ai/evaluation_runs/:evaluation_run_uuidTo retrive information about an existing evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}.
  • GETRetrieve Results of an Evaluation Run/v2/gen-ai/evaluation_runs/:evaluation_run_uuid/resultsTo retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results.
  • GETRetrieve Results of an Evaluation Run Prompt/v2/gen-ai/evaluation_runs/:evaluation_run_uuid/results/:prompt_idTo retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}.
  • GETList Evaluation Test Cases/v2/gen-ai/evaluation_test_casesTo list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.
  • POSTCreate Evaluation Test Case./v2/gen-ai/evaluation_test_casesTo create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.
  • GETList Evaluation Runs by Test Case/v2/gen-ai/evaluation_test_cases/:evaluation_test_case_uuid/evaluation_runsTo list all evaluation runs by test case, send a GET request to /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs.
  • GETRetrieve Information About an Existing Evaluation Test Case/v2/gen-ai/evaluation_test_cases/:test_case_uuidTo retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.
  • PUTUpdate an Evaluation Test Case./v2/gen-ai/evaluation_test_cases/:test_case_uuidTo update an evaluation test-case send a PUT request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.
  • GETList Indexing Jobs for a Knowledge Base/v2/gen-ai/indexing_jobsTo list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.
  • POSTStart Indexing Job for a Knowledge Base/v2/gen-ai/indexing_jobsTo start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.
  • GETList Data Sources for Indexing Job for a Knowledge Base/v2/gen-ai/indexing_jobs/:indexing_job_uuid/data_sourcesTo list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources.
  • GETGet Signed URL for Indexing Job Details/v2/gen-ai/indexing_jobs/:indexing_job_uuid/details_signed_urlTo get a signed URL for indexing job details, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}/details_signed_url.
  • GETRetrieve Status of Indexing Job for a Knowledge Base/v2/gen-ai/indexing_jobs/:uuidTo get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.
  • PUTCancel Indexing Job for a Knowledge Base/v2/gen-ai/indexing_jobs/:uuid/cancelTo cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.
  • GETList Knowledge Bases/v2/gen-ai/knowledge_basesTo list all knowledge bases, send a GET request to /v2/gen-ai/knowledge_bases.
  • POSTCreate a Knowledge Base/v2/gen-ai/knowledge_basesTo create a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases.
  • POSTCreate Presigned URLs for Data Source File Upload/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urlsTo create presigned URLs for knowledge base data source file upload, send a POST request to /v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls.
  • GETList Data Sources for a Knowledge Base/v2/gen-ai/knowledge_bases/:knowledge_base_uuid/data_sourcesTo list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
  • POSTAdd Data Source to a Knowledge Base/v2/gen-ai/knowledge_bases/:knowledge_base_uuid/data_sourcesTo add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
  • PUTUpdate Data Source options/v2/gen-ai/knowledge_bases/:knowledge_base_uuid/data_sources/:data_source_uuidTo update a data source (e.g. chunking options), send a PUT request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.
  • DELETEDelete a Data Source from a Knowledge Base/v2/gen-ai/knowledge_bases/:knowledge_base_uuid/data_sources/:data_source_uuidTo delete a data source from a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.
  • GETList Indexing Jobs for a Knowledge Base/v2/gen-ai/knowledge_bases/:knowledge_base_uuid/indexing_jobsTo list latest 15 indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs.
  • GETRetrieve Information About an Existing Knowledge Base/v2/gen-ai/knowledge_bases/:uuidTo retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.
  • PUTUpdate a Knowledge Base/v2/gen-ai/knowledge_bases/:uuidTo update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.
  • DELETEDelete a Knowledge Base/v2/gen-ai/knowledge_bases/:uuidTo delete a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{uuid}.
  • POSTCreate Presigned URLs for Model Evaluation Dataset File Upload/v2/gen-ai/model_evaluation/datasets/file_upload_presigned_urlsTo create presigned URLs for model evaluation dataset file upload, send a POST request to /v2/genai/model_evaluation/datasets/file_upload_presigned_urls.
  • GETList Model Evaluation Metrics/v2/gen-ai/model_evaluation_metricsTo list all available metrics for model evaluation, send a GET request to /v2/genai/model_evaluation_metrics.
  • GETList Model Evaluation Presets/v2/gen-ai/model_evaluation_presetsTo list all saved model evaluation presets, send a GET request to /v2/genai/model_evaluation_presets.
  • GETRetrieve Model Evaluation Preset/v2/gen-ai/model_evaluation_presets/:eval_preset_uuidTo retrieve a saved model evaluation preset, send a GET request to /v2/genai/model_evaluation_presets/{eval_preset_uuid}.
  • DELETEDelete Model Evaluation Preset/v2/gen-ai/model_evaluation_presets/:eval_preset_uuidTo delete a saved model evaluation preset, send a DELETE request to /v2/gen-ai/model_evaluation_presets/{eval_preset_uuid}.
  • GETList Model Evaluation Runs/v2/gen-ai/model_evaluation_runsTo list model evaluation runs, send a GET request to /v2/genai/model_evaluation_runs.
  • POSTCreate Model Evaluation Run/v2/gen-ai/model_evaluation_runsTo create a model evaluation run, send a POST request to /v2/genai/model_evaluation_runs.
  • GETRetrieve Model Evaluation Run/v2/gen-ai/model_evaluation_runs/:eval_run_uuidTo retrieve a model evaluation run, send a GET request to /v2/genai/model_evaluation_runs/{eval_run_uuid}.
  • DELETEDelete Model Evaluation Run/v2/gen-ai/model_evaluation_runs/:eval_run_uuidTo delete a model evaluation run, send a DELETE request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}. The run must be in a terminal status (successful,…
  • PATCHUpdate Model Evaluation Run/v2/gen-ai/model_evaluation_runs/:eval_run_uuidTo update a model evaluation run's display name, send a PATCH request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}.
  • PUTCancel Model Evaluation Run/v2/gen-ai/model_evaluation_runs/:eval_run_uuid/cancelTo cancel an in-progress model evaluation run, send a PUT request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}/cancel.
  • GETGet Download URL for Model Evaluation Run Results/v2/gen-ai/model_evaluation_runs/:eval_run_uuid/results/download_urlTo get a presigned download URL for model evaluation run results (gzip-compressed JSON), send a GET request to…
  • GETList Available Models/v2/gen-ai/modelsTo list all models, send a GET request to /v2/gen-ai/models.
  • GETList Model API Keys/v2/gen-ai/models/api_keysTo list all model API keys, send a GET request to /v2/gen-ai/models/api_keys.
  • POSTCreate a Model API Key/v2/gen-ai/models/api_keysDeprecated. Note: This endpoint is deprecated and has been retired. All requests return a 410 gone response. Creating model API keys through this endpoint is…
  • PUTUpdate API Key for a Model/v2/gen-ai/models/api_keys/:api_key_uuidTo update a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}.
  • DELETEDelete API Key for a Model/v2/gen-ai/models/api_keys/:api_key_uuidTo delete an API key for a model, send a DELETE request to /v2/gen-ai/models/api_keys/{api_key_uuid}.
  • PUTRegenerate API Key for a Model/v2/gen-ai/models/api_keys/:api_key_uuid/regenerateTo regenerate a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate.
  • GETList Model Catalog/v2/gen-ai/models/catalogReturns all available models.
  • GETGet Model Catalog Card/v2/gen-ai/models/catalog/:idReturns detailed information for a specific model in the catalog including capabilities, pricing, and code examples.
  • GETList Model Catalog V2/v2/gen-ai/models/catalog_v2Returns the model catalog using the V2 card shape (typed serving, badges, and modalities). Requires authentication.
  • GETGet Model Catalog Card V2/v2/gen-ai/models/catalog_v2/:idReturns a V2 catalog card by catalog ID or model ID. Requires authentication. Visibility matches List Model Catalog V2.
  • GETList Model Routers/v2/gen-ai/models/routersTo list model routers, send a GET request to /v2/gen-ai/models/routers.
  • POSTCreate a Model Router/v2/gen-ai/models/routersTo create a model router, send a POST request to /v2/gen-ai/models/routers.
  • GETList Model Router Presets/v2/gen-ai/models/routers/presetsTo list model router presets, send a GET request to /v2/gen-ai/models/routers/presets.
  • GETList Model Router Task Presets/v2/gen-ai/models/routers/tasks/presetsTo list model router task presets, send a GET request to /v2/gen-ai/models/routers/tasks/presets.
  • GETRetrieve an Existing Model Router/v2/gen-ai/models/routers/:uuidTo retrieve details of a model router, send a GET request to /v2/gen-ai/models/routers/{uuid}.
  • PUTUpdate a Model Router/v2/gen-ai/models/routers/:uuidTo update a model router, send a PUT request to /v2/gen-ai/models/routers/{uuid}.
  • DELETEDelete a Model Router/v2/gen-ai/models/routers/:uuidTo delete a model router, send a DELETE request to /v2/gen-ai/models/routers/{uuid}.
  • POSTGet Oauth2 Dropbox Tokens/v2/gen-ai/oauth2/dropbox/tokensTo obtain the refresh token, needed for creation of data sources, send a GET request to /v2/gen-ai/oauth2/dropbox/tokens. Pass the code you obtrained from the…
  • GETGet Oauth2 URL/v2/gen-ai/oauth2/urlTo generate an Oauth2-URL for use with your localhost, send a GET request to /v2/gen-ai/oauth2/url. Pass 'http://localhost:3000 as redirect_url
  • GETList OpenAI API Keys/v2/gen-ai/openai/keysTo list all OpenAI API keys, send a GET request to /v2/gen-ai/openai/keys.
  • POSTCreate OpenAI API Key/v2/gen-ai/openai/keysTo create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.
  • GETGet OpenAI API Key/v2/gen-ai/openai/keys/:api_key_uuidTo retrieve details of an OpenAI API key, send a GET request to /v2/gen-ai/openai/keys/{api_key_uuid}.
  • PUTUpdate OpenAI API Key/v2/gen-ai/openai/keys/:api_key_uuidTo update an OpenAI API key, send a PUT request to /v2/gen-ai/openai/keys/{api_key_uuid}.
  • DELETEDelete OpenAI API Key/v2/gen-ai/openai/keys/:api_key_uuidTo delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api_key_uuid}.
  • GETList agents by OpenAI key/v2/gen-ai/openai/keys/:uuid/agentsList Agents by OpenAI Key.
  • GETList Datacenter Regions/v2/gen-ai/regionsTo list all datacenter regions, send a GET request to /v2/gen-ai/regions.
  • GETList Common Scenario & Goal Library/v2/gen-ai/scenario_libraryTo list the platform-curated Common Scenario & Goal Library, send a GET request to /v2/gen-ai/scenario_library.
  • POSTCreate Scenario Set From Library/v2/gen-ai/scenario_library/:library_scenario_uuid/create_scenario_setTo create a scenario set from a Common Scenario & Goal Library entry, send a POST request to…
  • GETList Scenarios In Library Entry/v2/gen-ai/scenario_library/:library_scenario_uuid/scenariosTo list the scenarios inside a Common Scenario & Goal Library entry without creating a team-owned scenario set, send a GET request to…
  • GETList Scenario Sets/v2/gen-ai/scenario_setsTo list scenario sets, send a GET request to /v2/gen-ai/scenario_sets.
  • POSTCreate Scenario Set/v2/gen-ai/scenario_setsTo create a scenario set, send a POST request to /v2/gen-ai/scenario_sets. Provide exactly one of scenarios or file_upload_scenario_set. The set is created in…
  • POSTCreate Presigned URLs for Scenario Set File Upload/v2/gen-ai/scenario_sets/file_upload_presigned_urlsTo create presigned URLs for uploading a scenario set file, send a POST request to /v2/gen-ai/scenario_sets/file_upload_presigned_urls. After uploading, pass…
  • POSTGenerate Scenario Set/v2/gen-ai/scenario_sets/generateTo dispatch goal-driven scenario generation, send a POST request to /v2/gen-ai/scenario_sets/generate. The scenario set is returned in the generating state.…
  • GETRetrieve Scenario Set/v2/gen-ai/scenario_sets/:scenario_set_uuidTo retrieve a scenario set, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}.
  • PUTUpdate Scenario Set/v2/gen-ai/scenario_sets/:scenario_set_uuidTo update a scenario set in place, send a PUT request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}. Provide a new name and/or replacement scenarios. At…
  • DELETEDelete Scenario Set/v2/gen-ai/scenario_sets/:scenario_set_uuidTo delete a scenario set, send a DELETE request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}. A scenario set that is referenced by a simulation run cannot…
  • GETRetrieve Scenario Set Download URL/v2/gen-ai/scenario_sets/:scenario_set_uuid/download_urlTo retrieve a presigned download URL for a scenario set file, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/download_url.
  • POSTDuplicate Scenario Set/v2/gen-ai/scenario_sets/:scenario_set_uuid/duplicateTo duplicate a scenario set, send a POST request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/duplicate. The source set must be ready. The new set is named…
  • GETList Scenarios/v2/gen-ai/scenario_sets/:scenario_set_uuid/scenariosTo list the scenarios in a scenario set, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/scenarios.
  • POSTCreate scheduled indexing for knowledge base/v2/gen-ai/scheduled-indexingTo create scheduled indexing for a knowledge base, send a POST request to /v2/gen-ai/scheduled-indexing.
  • GETGet Scheduled Indexing for Knowledge Base/v2/gen-ai/scheduled-indexing/knowledge-base/:knowledge_base_uuidGet Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}.
  • DELETEDelete Scheduled Indexing/v2/gen-ai/scheduled-indexing/:uuidDelete Scheduled Indexing for knowledge base, send a DELETE request to /v2/gen-ai/scheduled-indexing/{uuid}.
  • GETList Simulation Runs/v2/gen-ai/simulation_runsTo list simulation runs, send a GET request to /v2/gen-ai/simulation_runs.
  • POSTCreate Simulation Run/v2/gen-ai/simulation_runsTo create a simulation run, send a POST request to /v2/gen-ai/simulation_runs. The scenario set must be ready. Judge and user simulator models are optional…
  • GETRetrieve Simulation Run/v2/gen-ai/simulation_runs/:run_uuidTo retrieve a simulation run, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}.
  • PUTUpdate Simulation Run/v2/gen-ai/simulation_runs/:run_uuidTo update a simulation run's display name, send a PUT request to /v2/gen-ai/simulation_runs/{run_uuid}. Only the name is mutable; run configuration and…
  • DELETEDelete Simulation Run/v2/gen-ai/simulation_runs/:run_uuidTo delete a simulation run, send a DELETE request to /v2/gen-ai/simulation_runs/{run_uuid}. The run must be in a terminal status…
  • PATCHCancel Simulation Run/v2/gen-ai/simulation_runs/:run_uuid/cancelTo cancel an in-progress simulation run, send a PATCH request to /v2/gen-ai/simulation_runs/{run_uuid}/cancel.
  • GETList Simulation Episodes/v2/gen-ai/simulation_runs/:run_uuid/episodesTo list the episodes within a simulation run, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes.
  • GETRetrieve Simulation Episode/v2/gen-ai/simulation_runs/:run_uuid/episodes/:episode_uuidTo retrieve a single episode, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes/{episode_uuid}.
  • GETRetrieve Episode Trajectory/v2/gen-ai/simulation_runs/:run_uuid/episodes/:episode_uuid/trajectoryTo retrieve an episode's live trajectory, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes/{episode_uuid}/trajectory. Poll while the…
  • GETRetrieve Episode Trajectory Download URL/v2/gen-ai/simulation_runs/:run_uuid/episodes/:episode_uuid/trajectory_urlTo retrieve a presigned download URL for an episode's trajectory, send a GET request to…
  • GETList Workspaces/v2/gen-ai/workspacesTo list all workspaces, send a GET request to /v2/gen-ai/workspaces.
  • POSTCreate a Workspace/v2/gen-ai/workspacesTo create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.
  • GETRetrieve an Existing Workspace/v2/gen-ai/workspaces/:workspace_uuidTo retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.
  • PUTUpdate a Workspace/v2/gen-ai/workspaces/:workspace_uuidTo update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.
  • DELETEDelete a Workspace/v2/gen-ai/workspaces/:workspace_uuidTo delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace_uuid}.
  • GETList agents by Workspace/v2/gen-ai/workspaces/:workspace_uuid/agentsTo list all agents by a Workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.
  • PUTMove Agents to a Workspace/v2/gen-ai/workspaces/:workspace_uuid/agentsTo move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.
  • GETList Evaluation Test Cases by Workspace/v2/gen-ai/workspaces/:workspace_uuid/evaluation_test_casesTo list all evaluation test cases by a workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases.

Harness Runtime

  • POSTStart an interactive provider login for the team./v2/agents/auth/:providerStarts, or resumes, the one-time login the team uses so a session can act on a provider. github is the provider served today; any other value returns 501. The…
  • GETCheck whether a provider login has finished./v2/agents/auth/:provider/poll?poll_url=https://example.invalid/pollPass the poll_url from the start response. The response reports only whether login has finished. No token or authorization handle is returned. github is the…
  • GETList the team's connections for a provider./v2/agents/auth/:provider/connectionsOne page of connections the team holds for {provider}. user_id is the actor identifier the connection acts for, not a DigitalOcean user id. A list never…
  • POSTCreate a provider connection for one actor./v2/agents/auth/:provider/connectionsCreates the connection {provider} will use for user_id. user_id is the actor identifier the connection acts for, not a DigitalOcean user id. Each actor has at…
  • GETRead one provider connection./v2/agents/auth/:provider/connections/:connection_idReturns one connection. Poll a pending connection with this call until authorization is absent. A connection that belongs to another provider than {provider}…
  • DELETERevoke a provider connection./v2/agents/auth/:provider/connections/:connection_idRevokes the connection and returns it. A connection that an environment config still uses is left in place and the error names those configs. There is no…
  • POSTStart a fresh login for an existing connection./v2/agents/auth/:provider/connections/:connection_id/reconnectResumes a pending connection's authorization, or starts a new one for an expired or revoked connection. The connection keeps its id, user_id, and scopes, so…
  • GETList sandbox-image notices for the team./v2/agents/image-messagesReturns the caller's sessions and checkpoints whose sandbox image carries a live notice. Pass session_name or checkpoint_name to look up one resource; those…
  • GETList active Environment Configs for the caller's team./v2/agents/configsReturns lightweight team-scoped config metadata without loading or returning environment-spec JSON. Soft-deleted configs are excluded.
  • POSTCreate an Environment Config (environment spec + optional Insights opt-in)./v2/agents/configsAccepts name, environment-spec YAML text, and optional Insights telemetry opt-in. Tenant secrets are declared inside the environment spec (write-only values),…
  • GETGet an active Environment Config and its environment spec./v2/agents/configs/:config_idReturns one team-scoped Environment Config including the sanitized environment spec and redacted credential slot metadata. Secret values are never returned.
  • DELETESoft-delete an Environment Config./v2/agents/configs/:config_idReleases the active team-scoped name; the config row is retained (soft delete), so sessions created from it keep a resolvable config_id.
  • POSTClone an Environment Config under a new name./v2/agents/configs/:config_id/cloneCopies the source config's sanitized manifest to a new UUID. Source and clone are independent (no lineage). Credential bindings are never copied: if the…
  • GETList the sessions created from one Environment Config./v2/agents/configs/:config_id/sessionsEnumerates the caller's team sessions whose session was created from this durable Environment Config. Keyset-paginated on an opaque cursor, newest first, same…
  • GETListRegions returns the regions the caller's team may create sessions and agent configs in./v2/harness-runtime/regionsPer-team catalog the UI (and other clients) render as the region picker, instead of hardcoding the list. A region is chosen by the API host you call, not by a…
  • GETListSessions enumerates sessions for the caller's tenant./v2/agents/sessionsKeyset-paginated on an opaque cursor. Results are scoped to the authenticated team. Destroyed and failed sessions are omitted by default (matching the Cloud…
  • POSTCreateSession provisions a sandbox and starts a Harness Runtime session./v2/agents/sessionsReturns once the session row is allocated. Sandbox boot completes asynchronously. Two mutually exclusive request forms are selected by Content-Type (same…
  • POSTValidatePolicy checks a manifest's tool-permission policy against the agent's capabilities without creating a session./v2/agents/sessions/policy/validateStateless preflight: parses the same environment spec as CreateSession and runs the identical resolve + validate pipeline against the capability descriptor…
  • GETListSandboxSizes returns the customer-selectable sandbox (microVM) size catalog./v2/agents/sessions/sandbox/sizesRead-only catalog the UI (and other clients) render as the size picker, instead of hardcoding the list. The set is the single source of truth shared with…
  • GETGetSession returns the current snapshot of a session./v2/agents/sessions/:session_idGetSession returns the current snapshot of a session.
  • DELETEDestroySession tears down the sandbox and marks the session DESTROYED./v2/agents/sessions/:session_idPersistent workspace contents are retained per tenant policy. A persistent workspace the session holds is saved and kept: it goes to RELEASING while the files…
  • PATCHPatchSession updates an existing session (session-scoped settings or live config)./v2/agents/sessions/:session_idPartial update of an existing session. Send exactly one of: resume_on_topoff (session-scoped consent), or manifest_yaml (live config update of tools, env and…
  • GETListCheckpoints enumerates a session's checkpoints, newest first./v2/agents/sessions/:session_id/checkpointsKeyset-paginated on an opaque cursor, like ListSessions.
  • POSTCreateCheckpoint captures the session's live sandbox state as a durable checkpoint./v2/agents/sessions/:session_id/checkpointsSynchronous: blocks until the capture reaches READY and returns the terminal Checkpoint — clients never see PENDING on this endpoint and need no poll loop.…
  • GETGetCheckpoint returns the current snapshot of a checkpoint./v2/agents/sessions/:session_id/checkpoints/:checkpoint_idGetCheckpoint returns the current snapshot of a checkpoint.
  • DELETEDeleteCheckpoint removes a checkpoint and its underlying machine-state capture./v2/agents/sessions/:session_id/checkpoints/:checkpoint_idIdempotent: deleting an already-gone checkpoint still returns 200. Removes the DB row and the substrate checkpoint.
  • GETRead sandbox-image notices for one checkpoint./v2/agents/sessions/:session_id/checkpoints/:checkpoint_id/image-messagesReturns the live notices on the checkpoint's sandbox image. The checkpoint must belong to {session_id}. type filters the notice kind; the only documented…
  • POSTRollbackToCheckpoint rewinds a session to a checkpoint./v2/agents/sessions/:session_id/checkpoints/:checkpoint_id/rollbackIn-place restore: boots a fresh sandbox from the checkpoint and atomically swaps the session's sandbox pointer to it, so the session keeps its same…
  • POSTForkSession creates child sessions from a checkpoint of this session./v2/agents/sessions/:session_id/forkEach child boots a fresh sandbox from the checkpoint's machine-state capture and is drivable exactly like any other session (input, HITL), with…
  • POSTResolveHITL records the user's decision on a pending HITL request./v2/agents/sessions/:session_id/hitl/:request_idharness-api forwards the decision into the owning microVM via the inbound runtime.v1.OHR.ResolveHITL RPC (dialed through the guest-fronting proxy), which…
  • POSTCancel the agent turn in flight./v2/agents/sessions/:session_id/cancelStops the turn POST /input started. Pass run_id from that response to name the turn; an empty body cancels whichever turn is in flight. outcome is acked when…
  • GETRead sandbox-image notices for one session./v2/agents/sessions/:session_id/image-messagesReturns the live notices on the session's sandbox image. type filters the notice kind; the only documented value is vulnerability. A session owned by another…
  • POSTSendInput delivers a user chat message into the session./v2/agents/sessions/:session_id/inputThe agent observes it on its next turn and emits subsequent events via StreamSession. The input is forwarded to the owning microVM's OHR inbound surface,…
  • POSTPauseSession freezes the session's microVM sandbox./v2/agents/sessions/:session_id/pauseSupported on microvm-substrate sessions only; dewdrop/docker sessions return 501 Not Implemented. Paused sessions count against quota. Clients learn state via…
  • POSTResumeSession explicitly thaws a PAUSED session's microVM sandbox./v2/agents/sessions/:session_id/resumeOnly valid for microvm-substrate sessions; dewdrop/docker sessions return 501 Not Implemented. Implicit resume also occurs when SendInput or ResolveHITL is…
  • POSTExecInSandbox runs a one-shot command inside the session's sandbox./v2/agents/sessions/:session_id/sandbox/execRuns argv directly in the guest (no shell). Stdout/stderr are buffered and capped at 1 MiB each; truncation is indicated via response headers when present. A…
  • GETDownload a file or tar archive from the session's sandbox workspace./v2/agents/sessions/:session_id/workspace/download?path=exampleStreams the workspace payload back as application/octet-stream using chunked transfer encoding, followed by a fixed integrity footer. Response body layout:…
  • POSTStart a staged (large-file) workspace transfer./v2/agents/sessions/:session_id/workspace/transfersCreates an asynchronous, object-storage-backed transfer for payloads larger than the streaming path supports (> ~50 MiB). Bulk bytes never traverse…
  • GETGet the status of a staged workspace transfer./v2/agents/sessions/:session_id/workspace/transfers/:transfer_idReturns the current transfer state. For a completed download the response also carries a freshly minted presigned GET download_url (its TTL starts at poll…
  • POSTCancel a staged workspace transfer./v2/agents/sessions/:session_id/workspace/transfers/:transfer_id/cancelAborts an in-flight transfer. Idempotent: cancelling an already-terminal transfer returns aborted: false with the current status. The request body is optional.
  • POSTFinalize a staged upload./v2/agents/sessions/:session_id/workspace/transfers/:transfer_id/commitUpload only. Call once, after all parts have been uploaded. Completes the multipart upload and starts the asynchronous import into the workspace. Responds…
  • POSTMint presigned PUT URLs for one or more multipart upload parts./v2/agents/sessions/:session_id/workspace/transfers/:transfer_id/part-upload-urlsUpload only. Pass one or more 1-based part_numbers; the response returns a presigned upload_url per part (all sharing one expires_at), so a client can drive…
  • POSTUpload a file or tar archive into the session's sandbox workspace./v2/agents/sessions/:session_id/workspace/upload?path=exampleStreams the raw request body to a path inside the sandbox workspace. Concurrent transfers (upload + download) are capped server-side; over the cap the request…
  • GETStreamSessionEvents opens the session's Server-Sent Events feed./v2/agents/sessions/:session_id/eventsOpens a text/event-stream of the session's canonical events, served by the MARS data plane (OHP). Each frame is event: <type> plus a data: line holding a JSON…
  • GETPortForwardSession opens a WebSocket tunnel to a guest TCP port./v2/agents/sessions/:session_id/port-forward/:portUpgrades the request to a WebSocket and bridges it to one TCP connection on the session sandbox's guest port. Binary frames carry the opaque byte stream in…
  • GETGetIngressURL returns the public HTTPS URL of the session's OpenHands Agent Server./v2/agents/sessions/:session_id/ingressPublishes the URL on first call and returns it. Idempotent while the session runs: the same URL is returned until the session is paused, locked or rolled…
  • GETListTeamTemplates returns the caller's team custom templates./v2/agents/templatesteam_id is stamped from the authenticated principal; never accepted from the client.
  • POSTCreateTemplate creates a team custom template and kicks a build./v2/agents/templatesCreates a team-owned template from a customer OCI ref rebased onto a base template. team_id is stamped from the authenticated principal.
  • GETGetTemplate returns a team custom template by public id./v2/agents/templates/:template_idGetTemplate returns a team custom template by public id.
  • PUTUpdateTemplate updates a team template's source and kicks a new build./v2/agents/templates/:template_idUpdateTemplate updates a team template's source and kicks a new build.
  • DELETEDeleteTemplate deletes a team custom template./v2/agents/templates/:template_idGlobal templates cannot be deleted via this API.
  • GETListTemplateBuilds returns build history for a template./v2/agents/templates/:template_id/buildsListTemplateBuilds returns build history for a template.
  • GETGetTemplateBuild returns a single template build./v2/agents/templates/:template_id/builds/:build_idGetTemplateBuild returns a single template build.
  • GETListTriggers enumerates the calling team's triggers./v2/agents/triggersKeyset-paginated on an opaque cursor. Excludes soft-deleted triggers. Scoped to the authenticated team.
  • POSTCreateTrigger creates a webhook or cron trigger./v2/agents/triggersValidation is synchronous, so a mistake is a 400/409 at creation, not a silent miss at the first fire. Exactly one of webhook / cron must be present and match…
  • GETGet the newest trigger bound to a session, or the trigger of its newest execution./v2/agents/triggers/by-session/:session_idReturns the newest trigger whose bound session is this one. Deleted triggers are skipped. When none is bound, returns the trigger of the newest execution for…
  • GETListReusableSessions lists the team's PAUSED sessions for the reuse picker./v2/agents/triggers/reusable-sessionsReturns the team's sessions in status PAUSED, for binding a session_mode=reuse trigger. The item shape is the hosted-agents Session, so agent_kind and status…
  • GETGetTrigger returns a single trigger by id./v2/agents/triggers/:trigger_idGetTrigger returns a single trigger by id. Write-only fields (webhook secret, output destination, session_template env values) are never included.
  • DELETEDeleteTrigger soft-deletes a trigger./v2/agents/triggers/:trigger_idMarks the trigger deleted, fails any pending executions, and purges the webhook secret / cron schedule. A fresh trigger owns no session; a reuse trigger only…
  • PATCHUpdateTrigger updates, pauses, or re-enables a trigger./v2/agents/triggers/:trigger_idPartial update: only the supplied fields change. kind and webhook.provider are immutable (409 on change). Mutable: name (409 on duplicate), status…
  • GETListTriggerExecutions returns a trigger's execution history./v2/agents/triggers/:trigger_id/executionsKeyset-paginated. The large payload field is omitted from list items; fetch a single execution to read it.
  • GETGetTriggerExecution returns a single execution, including its payload./v2/agents/triggers/:trigger_id/executions/:execution_idReturns the full execution row, including the payload, output_text, and output_truncated fields omitted from list items.
  • POSTCancelExecution ends a running execution and frees the trigger's in-flight slot./v2/agents/triggers/:trigger_id/executions/:execution_id/cancelFails the execution and frees the trigger's in-flight slot or session lock. A fresh-mode session is destroyed. In reuse mode the agent's current turn is…
  • POSTRotateTriggerSecret issues a new webhook secret./v2/agents/triggers/:trigger_id/rotate-secretWebhook triggers only (409 for cron). Issues a new secret (shown once) and moves the old value to the previous slot, where it keeps verifying deliveries until…
  • POSTReceiveTriggerWebhook accepts a signed delivery from an external system./v2/agents/triggers/:trigger_id/webhookThe one public, un-team-authenticated endpoint. There is NO DO bearer token: the caller is the customer's external system. Authentication is the per-trigger…
  • GETListWebhookProviders lists supported webhook providers for the create-trigger UI./v2/agents/webhook-providersA static, code-defined registry (not a database table), webhook-only. Cron triggers have no provider and never call this. Used to populate the provider…

Harness Runtime Workspaces [Public Preview]

  • GETList the team's persistent workspaces./v2/agents/workspacesLists the calling team's persistent workspaces, optionally only those in one state. A page can hold fewer results than page_size, so keep paging until…
  • POSTCreate a persistent workspace./v2/agents/workspacesCreates a persistent workspace with a fixed size limit. A workspace is a set of files with its own ID that is mounted at /workspace in the session it is…
  • GETGet a persistent workspace./v2/agents/workspaces/:workspace_idReturns one persistent workspace by its ID, including its state and when its files were last saved. Use it to wait for a workspace to return to AVAILABLE…
  • DELETEDelete a persistent workspace./v2/agents/workspaces/:workspace_idPermanently deletes a persistent workspace and its files. Only a workspace that is AVAILABLE or FAILED can be deleted; remove the session that holds it first.…

Apps

  • GETList All Apps/v2/appsList all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.
  • POSTCreate a New App/v2/appsCreate a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
  • GETRetrieve an Existing App/v2/apps/:idRetrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about…
  • PUTUpdate an App/v2/apps/:idUpdate an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product…
  • DELETEDelete an App/v2/apps/:idDelete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app…
  • POSTRestart an App/v2/apps/:app_id/restartPerform a rolling restart of all or specific components in an app.
  • GETRetrieve Active Deployment Logs/v2/apps/:app_id/components/:component_name/logs?type=BUILDRetrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or…
  • GETRetrieve Exec URL/v2/apps/:app_id/components/:component_name/execReturns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists.

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.digitalocean.com
Authentication
A bearer token in the Authorization header
A bearer token in the Authorization header
Operations
915 operations on 628 pathsGET 467POST 222DELETE 125PUT 77PATCH 24
24 marked deprecated
Main resources
Agent Platform API 144Monitoring 72Databases 71Harness Runtime 66Action Gateway 59Apps 38Insights 34Kubernetes 28MicroVMs [Public Preview] 21Container Registries 19
Response formats
application/json text/event-stream application/octet-stream audio/mpeg
Description format
OpenAPI 3.0.0, API version 2.0

How to test the DigitalOcean API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DigitalOcean API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List 1-Click Applications” (GET /v2/1-clicks), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DigitalOcean API?

Status of all DigitalOcean services It is listed under Developer tools and has 915 endpoints.

Who publishes the DigitalOcean API?

It is listed from DigitalOcean's public API description (an OpenAPI document), not published by DigitalOcean on Swastik Codes. Anyone who controls digitalocean.com can claim the profile by adding a DNS TXT record.

What is the base URL of the DigitalOcean API?

Requests go to https://api.digitalocean.com. Endpoint paths are added to this base URL.

How do I authenticate with the DigitalOcean API?

It accepts 2 methods: A bearer token in the Authorization header; A bearer token in the Authorization header.

How many endpoints does the DigitalOcean API have?

915 operations on 628 paths (467 GET, 222 POST, 125 DELETE, 77 PUT, 24 PATCH). The largest groups are Agent Platform API, Monitoring, Databases, Harness Runtime. This listing's collection holds the first 400.

Is forking the DigitalOcean API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.