Documentation menu
Projects

Update Environment Agent metadata

PATCH /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update Environment Agent metadata.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Update Environment Agent metadata.
agentIdstringrequiredIdentifies the Project Agent being addressed. Applies to Update Environment Agent metadata.

Request body

Required — Request body for: Update Environment Agent metadata.

application/json

NameTypeRequiredDescription
namestringoptional
descriptionstring | nulloptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — type: "agent" (required); id: string (required); slug: string (required); name: string (required); description: string; status: "draft" | "active" | "paused" | "deleting" (required); createdAt: string (required); updatedAt: string (required); scope: "project" (required); projectId: string (required); organizationId: string (required); environmentId: string (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)