NUnullplatform
Deployment

List deployments

Changed on

Lists all deployments that belong to an application or scope.

get/deployment

Request

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

Query parameters

offsetinteger

The starting point for pagination. Defaults to 0 if not provided.

limitinteger

The maximum number of results to return per page.

scope_idstring

Filters deployments by scope. Supports up to 10 comma-separated values.

application_idstring

Filters deployments by application. Supports a single value.

include_messagesboolean

Specifies whether it includes messages in the response.

Response

The list of deployments matching the query

Example response

{
  "paging": {
    "total": 30,
    "limit": 30
  },
  "results": [
    {
      "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