Sign in

v6

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2025-10-275815.8 KB
Promotions

Process an API promotion.

Accept or reject an API promotion.

post/organizations/{orgId}/promotions/{promotionId}/_process

Request body

acceptboolean

Accept or reject the API promotion.

Example request

{
  "accept": true
}

Response

The processed API promotion.

idstring

The promotion id.

apiDefinitionstring

The api definition.

apiIdstring

The api id.

status'CREATED' | 'TO_BE_VALIDATED' | 'ACCEPTED' | 'REJECTED' | 'ERROR'

The status of the promotion.

targetEnvCockpitIdstring

The target environment id where the promotion should be done.

targetEnvNamestring

The target environment name where the promotion should be done.

sourceEnvCockpitIdstring

The source environment id where the promotion should come from.

sourceEnvNamestring

The source environment name where the promotion should come from.

createdAtstring date-time

The datetime when the promotion was created.

updatedAtstring date-time

The datetime when the promotion was updated.

targetApiIdstring

The target api id.

Example response

{
  "id": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
  "apiId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
  "targetEnvCockpitId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
  "targetEnvName": "prod",
  "sourceEnvCockpitId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
  "sourceEnvName": "dev",
  "createdAt": "2023-05-25T12:40:46.184Z",
  "updatedAt": "2023-05-25T12:40:46.184Z",
  "author": {
    "userId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076",
    "displayName": "John Doe",
    "email": "email@example.com",
    "source": "cockpit",
    "sourceId": "89eb0e39-1706-49c1-ab0e-391706d9c10a"
  },
  "targetApiId": "df83b2a4-cc3e-3f80-9f0d-c138c106c076"
}