Deployment strategy

List deployment strategies

Retrieves a paginated list of deployment strategies

get/deployment_strategy

Query parameters

offsetinteger

Number of items to skip.

limitinteger

Maximum number of items to return.

nrnstring required

Filter by NRN.

scope_type_idstring

Filter by scope type ID.

include'types'

Include related entities (types).

Response

List of deployment strategies matching the query"

Example response

{
  "paging": {
    "total": 30,
    "limit": 200
  },
  "results": [
    {
      "id": "12345",
      "name": "Critical deployment strategy",
      "description": "Strategy for critical deployments that checks error rate and rollbacks if needed",
      "nrn": "organization=1:account=2:namespace=3:application=4",
      "dimensions": {
        "environment": "staging"
      },
      "parameters": {
        "type": "object",
        "title": "Deployment strategy parameters",
        "properties": {
          "metrics": {
            "type": "object",
            "description": "Configure metric-based rollback",
            "properties": {
              "enabled": {
                "type": "boolean",
                "default": true
              },
              "rules": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "examples": [
                        "http.error_rate"
                      ]
                    },
                    "threshold": {
                      "type": "number"
                    },
                    "operator": {
                      "type": "string",
                      "enum": [
                        "greater_than",
                        "less_than",
                        "equals"
                      ]
                    }
                  },
                  "required": [
                    "name",
                    "threshold",
                    "operator"
                  ]
                },
                "default": [
                  {
                    "name": "http.error_rate",
                    "threshold": 0.5,
                    "operator": "less_than"
                  }
                ]
              }
            },
            "required": [
              "enabled"
            ]
          },
          "traffic": {
            "type": "object",
            "description": "Configure traffic switching",
            "properties": {
              "enable_auto_switch": {
                "type": "boolean",
                "default": false
              },
              "interval": {
                "type": "integer",
                "default": 10
              },
              "step": {
                "oneOf": [
                  {
                    "const": 0.1,
                    "title": "10%"
                  },
                  {
                    "const": 0.5,
                    "title": "50%"
                  },
                  {
                    "const": 1,
                    "title": "100%"
                  }
                ],
                "default": 0.1
              }
            },
            "required": [
              "enable_auto_switch",
              "interval",
              "step"
            ]
          }
        },
        "required": [
          "metrics",
          "traffic"
        ]
      },
      "scope_type_ids": [
        "12345",
        "67890"
      ],
      "created_by": "123",
      "updated_by": "456",
      "created_at": "2023-10-01T12:34:56Z",
      "updated_at": "2023-10-01T12:34:56Z"
    }
  ]
}

Changes