Jump to

• Request
• Response

Get all promotion logs

get

https://{your_site_interface}/opa-hub/api/12.2.36/deployments/{deployment-name}/promotions

This operation will get all promotion logs.

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : promotionLogs

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentPromotion"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentPromotion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentPromotion"
    }
}

Nested Schema : deploymentPromotion

Type: object

Show Source

• activationStatus: integer (int64)
  Read Only: true

  The promoted deployment's activation status.
• promotedBy: string
  Read Only: true

  The user name of the person performing the action.
• promotedVersion: integer (int64)
  Read Only: true

  The promoted deployment version.
• promotionDate: string (date-time)
  Read Only: true

  The date and time at which the promotion occurred.
• srcEnv: string
  Read Only: true

  The name of the source environment.
• targetEnv: string
  Read Only: true

  The name of the target environment.

{
    "type":"object",
    "properties":{
        "promotionDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time at which the promotion occurred.",
            "readOnly":true
        },
        "targetEnv":{
            "type":"string",
            "description":"The name of the target environment.",
            "readOnly":true
        },
        "srcEnv":{
            "type":"string",
            "description":"The name of the source environment.",
            "readOnly":true
        },
        "promotedBy":{
            "type":"string",
            "description":"The user name of the person performing the action.",
            "readOnly":true
        },
        "promotedVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The promoted deployment version.",
            "readOnly":true
        },
        "activationStatus":{
            "type":"integer",
            "format":"int64",
            "description":"The promoted deployment's activation status.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top