---
title: "Get an environment's desired state, as its file says"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Deploy API

`GET /v1/organizations/{orgId}/deploy/stacks/{stackId}/environments/{environmentId}/desired`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetDesiredState.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `GetDesiredState.path.stackId` (string, required) — UUID or prefixed ID (dps_…)
- `GetDesiredState.path.environmentId` (string, required) — UUID or prefixed ID (den_…)

## Query parameters

- `GetDesiredState.query.changeset` (string, optional) — A changeset (dch_…) of the environment: its edited file instead of the branch head's.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://deploy.ezghcloud.com/v1/organizations/string/deploy/stacks/string/environments/string/desired \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://deploy.ezghcloud.com/v1/organizations/string/deploy/stacks/string/environments/string/desired';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://deploy.ezghcloud.com/v1/organizations/string/deploy/stacks/string/environments/string/desired"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Success.

#### Example

```json
{
  "attributes": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "desired": {
    "alerts": [
      {
        "contactPoints": [
          "string"
        ],
        "forSeconds": 0,
        "name": "string",
        "promql": "string"
      }
    ],
    "ci": {
      "registry": "string",
      "requires": [
        "string"
      ]
    },
    "environment": {
      "approve": true,
      "branch": "string",
      "name": "string",
      "project": "string"
    },
    "name": "string",
    "region": "string",
    "resources": {
      "property1": {
        "bucket": {
          "corsRules": [
            {
              "allowedHeaders": [
                null
              ],
              "allowedMethods": [
                null
              ],
              "allowedOrigins": [
                null
              ],
              "exposeHeaders": [
                null
              ],
              "maxAgeSeconds": 0
            }
          ],
          "publicRead": true
        },
        "cache": {
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "standby": true,
          "storage": {
            "sizeGiB": 0
          }
        },
        "database": {
          "backup": {
            "retentionDays": 0
          },
          "deletionProtection": true,
          "engineVersion": "string",
          "instanceType": "string",
          "logicalDatabases": [
            "string"
          ],
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "storage": {
            "sizeGiB": 0
          }
        },
        "kafka": {
          "access": "string",
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "storage": {
            "sizeGiB": 0
          },
          "topics": [
            {
              "name": "string",
              "partitions": 0,
              "replicationFactor": 0
            }
          ]
        },
        "name": "string",
        "queue": {
          "queueType": "string",
          "redrive": {
            "deadLetterQueue": "string",
            "maxReceiveCount": 0
          },
          "retentionSeconds": 0,
          "visibilityTimeoutSeconds": 0
        },
        "rabbitmq": {
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "queues": [
            {
              "name": "string",
              "type": "string"
            }
          ],
          "storage": {
            "sizeGiB": 0
          },
          "vhost": "string"
        },
        "type": "string",
        "warehouse": {
          "access": "string",
          "databases": [
            {
              "name": "string"
            }
          ],
          "engineVersion": "string",
          "instanceType": "string",
          "replicas": 0,
          "shards": 0,
          "storage": {
            "sizeGiB": 0
          }
        }
      },
      "property2": {
        "bucket": {
          "corsRules": [
            {
              "allowedHeaders": [
                null
              ],
              "allowedMethods": [
                null
              ],
              "allowedOrigins": [
                null
              ],
              "exposeHeaders": [
                null
              ],
              "maxAgeSeconds": 0
            }
          ],
          "publicRead": true
        },
        "cache": {
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "standby": true,
          "storage": {
            "sizeGiB": 0
          }
        },
        "database": {
          "backup": {
            "retentionDays": 0
          },
          "deletionProtection": true,
          "engineVersion": "string",
          "instanceType": "string",
          "logicalDatabases": [
            "string"
          ],
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "storage": {
            "sizeGiB": 0
          }
        },
        "kafka": {
          "access": "string",
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "storage": {
            "sizeGiB": 0
          },
          "topics": [
            {
              "name": "string",
              "partitions": 0,
              "replicationFactor": 0
            }
          ]
        },
        "name": "string",
        "queue": {
          "queueType": "string",
          "redrive": {
            "deadLetterQueue": "string",
            "maxReceiveCount": 0
          },
          "retentionSeconds": 0,
          "visibilityTimeoutSeconds": 0
        },
        "rabbitmq": {
          "engineVersion": "string",
          "instanceType": "string",
          "mode": "string",
          "queues": [
            {
              "name": "string",
              "type": "string"
            }
          ],
          "storage": {
            "sizeGiB": 0
          },
          "vhost": "string"
        },
        "type": "string",
        "warehouse": {
          "access": "string",
          "databases": [
            {
              "name": "string"
            }
          ],
          "engineVersion": "string",
          "instanceType": "string",
          "replicas": 0,
          "shards": 0,
          "storage": {
            "sizeGiB": 0
          }
        }
      }
    },
    "runtime": {
      "image": "string",
      "mode": "string"
    },
    "sandboxImages": {
      "property1": {
        "build": {
          "buildCommand": "string",
          "installCommand": "string",
          "startCommand": "string"
        },
        "dockerfile": "string",
        "source": "string"
      },
      "property2": {
        "build": {
          "buildCommand": "string",
          "installCommand": "string",
          "startCommand": "string"
        },
        "dockerfile": "string",
        "source": "string"
      }
    },
    "secrets": {
      "property1": {
        "fields": [
          "string"
        ],
        "generate": {
          "property1": {
            "length": 0
          },
          "property2": {
            "length": 0
          }
        }
      },
      "property2": {
        "fields": [
          "string"
        ],
        "generate": {
          "property1": {
            "length": 0
          },
          "property2": {
            "length": 0
          }
        }
      }
    },
    "services": {
      "property1": {
        "access": {
          "property1": "string",
          "property2": "string"
        },
        "build": {
          "buildCommand": "string",
          "installCommand": "string",
          "startCommand": "string"
        },
        "command": "string",
        "dockerfile": "string",
        "env": {
          "property1": {
            "ref": {
              "attr": "string",
              "field": "string",
              "kind": "string",
              "name": "string"
            },
            "value": "string"
          },
          "property2": {
            "ref": {
              "attr": "string",
              "field": "string",
              "kind": "string",
              "name": "string"
            },
            "value": "string"
          }
        },
        "from": "string",
        "health": {
          "healthyThreshold": 0,
          "intervalSeconds": 0,
          "path": "string",
          "timeoutSeconds": 0,
          "unhealthyThreshold": 0
        },
        "image": "string",
        "instanceType": "string",
        "port": 0,
        "public": {
          "cdn": {
            "enabled": true,
            "rewrites": [
              {}
            ]
          },
          "domains": [
            "string"
          ],
          "lb": {
            "idleTimeoutSeconds": 0,
            "protocol": "string"
          },
          "waf": {
            "enabled": true,
            "managedRuleSets": [
              "string"
            ],
            "mode": "string"
          }
        },
        "release": {
          "command": "string",
          "timeoutSeconds": 0
        },
        "resources": {
          "cpu": "string",
          "memory": "string"
        },
        "rollout": {
          "batchPercent": 0,
          "steps": [
            {
              "pauseSeconds": 0,
              "weight": 0
            }
          ],
          "strategy": "string"
        },
        "sandboxes": true,
        "scale": {
          "max": 0,
          "min": 0,
          "target": {
            "cpuUtilization": 0,
            "memoryUtilization": 0,
            "queue": "string",
            "visiblePerInstance": 0
          }
        },
        "schedule": "string",
        "shutdown": {
          "graceSeconds": 0
        },
        "source": "string",
        "type": "string"
      },
      "property2": {
        "access": {
          "property1": "string",
          "property2": "string"
        },
        "build": {
          "buildCommand": "string",
          "installCommand": "string",
          "startCommand": "string"
        },
        "command": "string",
        "dockerfile": "string",
        "env": {
          "property1": {
            "ref": {
              "attr": "string",
              "field": "string",
              "kind": "string",
              "name": "string"
            },
            "value": "string"
          },
          "property2": {
            "ref": {
              "attr": "string",
              "field": "string",
              "kind": "string",
              "name": "string"
            },
            "value": "string"
          }
        },
        "from": "string",
        "health": {
          "healthyThreshold": 0,
          "intervalSeconds": 0,
          "path": "string",
          "timeoutSeconds": 0,
          "unhealthyThreshold": 0
        },
        "image": "string",
        "instanceType": "string",
        "port": 0,
        "public": {
          "cdn": {
            "enabled": true,
            "rewrites": [
              {}
            ]
          },
          "domains": [
            "string"
          ],
          "lb": {
            "idleTimeoutSeconds": 0,
            "protocol": "string"
          },
          "waf": {
            "enabled": true,
            "managedRuleSets": [
              "string"
            ],
            "mode": "string"
          }
        },
        "release": {
          "command": "string",
          "timeoutSeconds": 0
        },
        "resources": {
          "cpu": "string",
          "memory": "string"
        },
        "rollout": {
          "batchPercent": 0,
          "steps": [
            {
              "pauseSeconds": 0,
              "weight": 0
            }
          ],
          "strategy": "string"
        },
        "sandboxes": true,
        "scale": {
          "max": 0,
          "min": 0,
          "target": {
            "cpuUtilization": 0,
            "memoryUtilization": 0,
            "queue": "string",
            "visiblePerInstance": 0
          }
        },
        "schedule": "string",
        "shutdown": {
          "graceSeconds": 0
        },
        "source": "string",
        "type": "string"
      }
    },
    "version": 0
  },
  "edges": [
    {
      "attr": "string",
      "from": "string",
      "to": "string"
    }
  ]
}
```

- `GetDesiredState.response.200.attributes` (map<array<string>>, required) — The attributes a reference can name, by resource type and service.
- `GetDesiredState.response.200.desired` (object, required)
  - `GetDesiredState.response.200.desired.alerts` (array | null, required)
  - `GetDesiredState.response.200.desired.ci` (object, required)
    - `GetDesiredState.response.200.desired.ci.registry` (string | null, required)
    - `GetDesiredState.response.200.desired.ci.requires` (array | null, required)
  - `GetDesiredState.response.200.desired.environment` (object, required)
    - `GetDesiredState.response.200.desired.environment.approve` (boolean, required)
    - `GetDesiredState.response.200.desired.environment.branch` (string, required)
    - `GetDesiredState.response.200.desired.environment.name` (string, required)
    - `GetDesiredState.response.200.desired.environment.project` (string, required)
  - `GetDesiredState.response.200.desired.name` (string, required)
  - `GetDesiredState.response.200.desired.region` (string, required)
  - `GetDesiredState.response.200.desired.resources` (object | null, required)
  - `GetDesiredState.response.200.desired.runtime` (object, required)
    - `GetDesiredState.response.200.desired.runtime.image` (string, required)
    - `GetDesiredState.response.200.desired.runtime.mode` (string, required)
  - `GetDesiredState.response.200.desired.sandboxImages` (object | null, required)
  - `GetDesiredState.response.200.desired.secrets` (object | null, required)
  - `GetDesiredState.response.200.desired.services` (object | null, required)
  - `GetDesiredState.response.200.desired.version` (integer, required)
- `GetDesiredState.response.200.edges` (array<object>, required)
  - `GetDesiredState.response.200.edges.attr` (string, required)
  - `GetDesiredState.response.200.edges.from` (string, required)
  - `GetDesiredState.response.200.edges.to` (string, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.400.error` (object, required)
  - `GetDesiredState.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.400.error.issues.message` (string, required)
    - `GetDesiredState.response.400.error.issues.path` (string, required)
  - `GetDesiredState.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.400.error.quota.id` (string, required)
    - `GetDesiredState.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.400.error.quota.region` (string, optional)
    - `GetDesiredState.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.401.error` (object, required)
  - `GetDesiredState.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.401.error.issues.message` (string, required)
    - `GetDesiredState.response.401.error.issues.path` (string, required)
  - `GetDesiredState.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.401.error.quota.id` (string, required)
    - `GetDesiredState.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.401.error.quota.region` (string, optional)
    - `GetDesiredState.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.403.error` (object, required)
  - `GetDesiredState.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.403.error.issues.message` (string, required)
    - `GetDesiredState.response.403.error.issues.path` (string, required)
  - `GetDesiredState.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.403.error.quota.id` (string, required)
    - `GetDesiredState.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.403.error.quota.region` (string, optional)
    - `GetDesiredState.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.404.error` (object, required)
  - `GetDesiredState.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.404.error.issues.message` (string, required)
    - `GetDesiredState.response.404.error.issues.path` (string, required)
  - `GetDesiredState.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.404.error.quota.id` (string, required)
    - `GetDesiredState.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.404.error.quota.region` (string, optional)
    - `GetDesiredState.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.429.error` (object, required)
  - `GetDesiredState.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.429.error.issues.message` (string, required)
    - `GetDesiredState.response.429.error.issues.path` (string, required)
  - `GetDesiredState.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.429.error.quota.id` (string, required)
    - `GetDesiredState.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.429.error.quota.region` (string, optional)
    - `GetDesiredState.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.500.error` (object, required)
  - `GetDesiredState.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.500.error.issues.message` (string, required)
    - `GetDesiredState.response.500.error.issues.path` (string, required)
  - `GetDesiredState.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.500.error.quota.id` (string, required)
    - `GetDesiredState.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.500.error.quota.region` (string, optional)
    - `GetDesiredState.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDesiredState.response.503.error` (object, required)
  - `GetDesiredState.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDesiredState.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetDesiredState.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDesiredState.response.503.error.issues.message` (string, required)
    - `GetDesiredState.response.503.error.issues.path` (string, required)
  - `GetDesiredState.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDesiredState.response.503.error.quota.id` (string, required)
    - `GetDesiredState.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDesiredState.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetDesiredState.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDesiredState.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDesiredState.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.503.error.quota.region` (string, optional)
    - `GetDesiredState.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDesiredState.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetDesiredState.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetDesiredState.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/deploy-api/GetDesiredState/index.md
