v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Deployment Gates

Update deployment rule

Endpoint to update a deployment rule.

put/api/v2/deployment_gates/{gate_id}/rules/{id}

Path parameters

gate_idstring required

The ID of the deployment gate.

idstring required

The ID of the deployment rule.

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "Updated deployment rule",
      "options": {
        "duration": 3600,
        "excluded_resources": [
          "resource1",
          "resource2"
        ]
      }
    },
    "type": "deployment_rule"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "created_at": "2021-01-01T00:00:00Z",
      "created_by": {
        "handle": "test-user",
        "id": "1111-2222-3333-4444-555566667777",
        "name": "Test User"
      },
      "gate_id": "1111-2222-3333-4444-555566667777",
      "name": "My deployment rule",
      "options": {
        "duration": 3600,
        "excluded_resources": [
          "resource1",
          "resource2"
        ]
      },
      "type": "faulty_deployment_detection",
      "updated_by": {
        "handle": "test-user",
        "id": "1111-2222-3333-4444-555566667777",
        "name": "Test User"
      }
    },
    "id": "1111-2222-3333-4444-555566667777",
    "type": "deployment_rule"
  }
}