Get a Project Delivery topology promotion
GET
/v1/release-control/project-delivery-promotions/{promotionId}How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| promotionId | path | string | Yes | — |
Query parameters
None.
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Promotion, resource states, deployment requests, and append-only event ledgerapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| promotion | object | Yes | — |
| promotion.id | string | Yes | Unique identifier. |
| promotion.object | project_delivery_release_promotion | Yes | — |
| promotion.status | ready_for_deployment | ready_for_activation | activating | released | failed | cancelled | Yes | Current lifecycle status. |
| promotion.authorizationId | string | Yes | — |
| promotion.topologyCandidateId | string | Yes | — |
| promotion.projectId | string | Yes | Project ID. |
| promotion.deliveryExecutionId | string | Yes | — |
| promotion.candidateManifestFingerprint | string | Yes | — |
| promotion.releaseFingerprint | string | Yes | — |
| promotion.authorizationEvidenceFingerprint | string | Yes | — |
| promotion.idempotencyKey | string | Yes | — |
| promotion.requestFingerprint | string | Yes | — |
| promotion.receiptFingerprint | string | Yes | — |
| promotion.revision | integer | Yes | — |
| promotion.error | object | Yes | — |
| promotion.error.code | string | Yes | — |
| promotion.error.message | string | Yes | Message text. |
| promotion.activationStartedAt | string | Yes | — |
| promotion.completedAt | string | Yes | ISO 8601 timestamp. |
| promotion.createdAt | string | Yes | ISO 8601 timestamp. |
| promotion.updatedAt | string | Yes | ISO 8601 timestamp. |
| promotion.resources | object[] | Yes | — |
| promotion.resources[].id | string | Yes | Unique identifier. |
| promotion.resources[].resourceCandidateId | string | Yes | — |
| promotion.resources[].key | string | Yes | — |
| promotion.resources[].targetKind | function | metronome | Yes | — |
| promotion.resources[].targetResourceId | string | Yes | — |
| promotion.resources[].candidateVersionId | string | Yes | — |
| promotion.resources[].candidateFingerprint | string | Yes | — |
| promotion.resources[].activatedVersionId | string | Yes | — |
| promotion.resources[].activatedFingerprint | string | Yes | — |
| promotion.resources[].status | pending | deploying | staged | activated | failed | cancelled | Yes | Current lifecycle status. |
| promotion.resources[].deploymentAttemptId | string | Yes | — |
| promotion.resources[].deploymentId | string | Yes | — |
| promotion.resources[].deploymentRevision | string | Yes | — |
| promotion.resources[].serviceName | string | Yes | — |
| promotion.resources[].region | string | Yes | — |
| promotion.resources[].previousDeploymentRevision | string | Yes | — |
| promotion.resources[].stagedAt | string | Yes | — |
| promotion.resources[].activatedAt | string | Yes | — |
| promotion.resources[].deploymentRequest | object | Yes | — |
| promotion.resources[].deploymentRequest.method | POST | Yes | — |
| promotion.resources[].deploymentRequest.path | string | Yes | Workspace-relative file path. |
| promotion.resources[].deploymentRequest.body | object | Yes | — |
| promotion.resources[].deploymentRequest.body.versionId | string | Yes | — |
| promotion.resources[].deploymentRequest.body.projectDeliveryPromotionId | string | Yes | — |
| promotion.resources[].deploymentRequest.body.projectDeliveryResourceCandidateId | string | Yes | — |
| promotion.resources[].error | object | Yes | — |
| promotion.resources[].error.code | string | Yes | — |
| promotion.resources[].error.message | string | Yes | Message text. |
| promotion.events | object[] | No | — |
| promotion.events[].sequence | integer | Yes | — |
| promotion.events[].id | string | Yes | Unique identifier. |
| promotion.events[].type | string | Yes | — |
| promotion.events[].actorUserId | string | Yes | — |
| promotion.events[].payload | object | Yes | — |
| promotion.events[].createdAt | string | Yes | ISO 8601 timestamp. |
404Promotion not found or inaccessible
None.
Get a Project Delivery topology promotion
Loading...
Response 200
Loading...