Documentation menu
Projects

Delete a project agent

DELETE /api/v1/projects/{projectId}/agents/{agentId}

Marks the Project Agent as deleting and returns 202 with the canonical resource. New execution admission is disabled; existing immutable revisions, deployments and run history are retained. No prior cancellation of jobs or runs is required.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Delete a project agent.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Delete a project agent.

Responses

StatusDescriptionBody
202Response for status 202application/json — object — agent: object (required); deleting: true (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)