Skip to main content

Update deployment by UUID

PUT 

/api/v1/catalog/:tag/deploys/:uuid

Update deployment by UUID

Request

Path Parameters

    tag stringrequired

    The entity tag (x-cortex-tag) that identifies the entity.

    uuid uuidrequired

Body

required
    customData object
    property name* object
    deployer object
    email string
    name string
    environment string
    sha string
    timestamp date-timerequired
    title stringrequired
    type stringrequired

    Possible values: [DEPLOY, SCALE, ROLLBACK, RESTART]

    url string

Responses

Successfully updated deployment

Schema
    customData object

    Arbitrary string-to-any map of custom data about the deploy event

    property name* object

    Arbitrary string-to-any map of custom data about the deploy event

    deployer object
    email string
    name string
    deployerEmail stringdeprecated

    Replaced with Deployer object

    deployerName stringdeprecated

    Replaced with Deployer object

    environment string
    sha string

    Optional commit SHA hash that this deploy corresponds to

    timestamp date-timerequired

    ISO8601 timestamp string in UTC

    title stringrequired

    Human readable title for the deploy. This is usually the commit message or PR title.

    type stringrequired

    Possible values: [DEPLOY, SCALE, ROLLBACK, RESTART]

    url string

    Optional URL associated with deployment

    uuid uuidrequired
Loading...