NUnullplatform
Deployment

Update a deployment

Changed on

Updates information for a deployment

patch/deployment/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/deployment/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the deployment.

Request body

statusstring

The updated status of the deployment.

Example request

{
  "status": "finalized",
  "strategy_data": {
    "desired_switched_traffic": 50
  },
  "messages": [
    {
      "level": "INFO",
      "message": "Deployment started successfully",
      "code": "DEPLOYMENT_STARTED",
      "timestamp": 1696166096
    }
  ]
}

Response

The operation was successful.

idinteger required

The unique ID for the deployment.

scope_idinteger required

The ID of the scope where the deployment belongs.

release_idinteger required

The ID of the release associated with the deployment.

status'creating_approval' | 'creating_approval_denied' | 'creating' | 'waiting_for_instances' | 'running' | 'finalizing' | 'finalized' | 'cancelling' | 'cancelled' | 'failed' | 'rolling_back' | 'rolled_back' | 'deleting' | 'deleted' required

The current status of the deployment.

status_in_scopestring

The status of the deployment within its scope.

strategy'initial' | 'blue_green' required

The deployment strategy being used.

created_atstring date-time required

The timestamp when the deployment was created.

updated_atstring date-time required

The timestamp when the deployment was last updated.

deployment_tokenstring required

A unique token associated with the deployment for authentication or tracking purposes.

nrnstring required

The resource name (NRN) uniquely identifying the deployment.

Example response

{
  "id": 1,
  "scope_id": 1234,
  "release_id": 5678,
  "status": "running",
  "status_in_scope": "ACTIVE",
  "strategy": "blue_green",
  "strategy_data": {
    "switched_traffic": 30,
    "desired_switched_traffic": 50,
    "amount_instances_to_wait": 5,
    "healthy_instances": 3,
    "launched_instances": 5,
    "switch_traffic_step": true
  },
  "created_at": "2023-10-01T12:34:56Z",
  "updated_at": "2023-10-01T12:34:56Z",
  "messages": [
    {
      "level": "INFO",
      "message": "Deployment started successfully",
      "code": "DEPLOYMENT_STARTED",
      "timestamp": 1696166096
    }
  ],
  "deployment_token": "abc123xyz",
  "nrn": "organization=1:account=2:namespace=4:application=4:scope=5"
}

Changes

  • 728d4df70ca1Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status