List deployment variables by deployment

Changed on

Returns a list of variables for a deployment, including their configured values.

get/v1/workspaces/{workspaceId}/deployments/{deploymentId}/variables

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/deployments/{deploymentId}/variables
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

deploymentIdstring required

ID of the deployment

Query parameters

limitinteger

Maximum number of items to return

offsetinteger

Number of items to skip

Response

Paginated list of items

limitinteger required

Maximum number of items returned

offsetinteger required

Number of items skipped

totalinteger required

Total number of items available

Changes

    • warning

      removed the optional property /// from the response with the status

    • breaking

      the //// response's property type changed from no type to string for status

    • info

      removed from the //// response property oneOf list for the response status