Deployments

Drifts

List the deployments which have been deployed since this deployment was staged.

get/deployments/{deployment_id}/drifts

Path parameters

deployment_idstring required
Example:dpl_123

The unique identifier of the deployment.

Query parameters

expandDeploymentExpansion[]

Fields to expand on the deployment resource.

[
  "device"
]

Response

Successfully retrieved the deployment drifts.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "deployment",
      "id": "dpl_123",
      "description": "Deployment for the motion control config instance",
      "status": "staged",
      "activity_status": "staged",
      "error_status": "none",
      "target_status": "staged",
      "device_id": "dvc_123",
      "release_id": "rls_123",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

Changed in 3 of the 6 revisions of this API.413

    • added the new jsonc enum value to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/content/allOf[subschema #1: Instance Content]/format response property for the response status 200

      response-property-enum-value-added

    • added the new removing enum value to the allOf[subschema #2]/data/items/allOf[subschema #1: Base Deployment]/activity_status response property for the response status 200

      response-property-enum-value-added

    • added the new removing enum value to the allOf[subschema #2]/data/items/allOf[subschema #1: Base Deployment]/status response property for the response status 200

      response-property-enum-value-added

    • added the new yaml enum value to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/content/allOf[subschema #1: Instance Content]/format response property for the response status 200

      response-property-enum-value-added

    • added subschema #2 to the allOf[subschema #2]/data/items/allOf[subschema #2]/device/allOf[Device]/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added ConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_schema/allOf[subschema #1: Config Schema]/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • added ConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • added ConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/release/allOf[subschema #1: Release]/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • removed BaseConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_schema/allOf[subschema #1: Config Schema]/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BaseConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • removed BaseConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/release/allOf[subschema #1: Release]/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • added BaseConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_schema/allOf[subschema #1: Config Schema]/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • added BaseConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • added BaseConfigType to the allOf[subschema #2]/data/items/allOf[subschema #2]/release/allOf[subschema #1: Release]/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-added

    • removed ConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_schema/allOf[subschema #1: Config Schema]/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • removed ConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/config_instances/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    • removed ConfigType from the allOf[subschema #2]/data/items/allOf[subschema #2]/release/allOf[subschema #1: Release]/allOf[subschema #2]/config_schemas/items/allOf[subschema #2]/config_type response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog