{"openapi":"3.1.0","jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","info":{"title":"Deutsche Cloud API","version":"1.0.0","description":"Programmatic access to Deutsche Cloud cloud services. Every request carries an `Authorization` header of the form `EWS-ACCESS-KEY EWS1XXXXXXXXXXXXXXXX:<40-char-secret>`, and every operation is authorized against the IAM action named in its `x-ews-action` field.\n\nThis document is generated from `src/lib/api-surface/`, the same description the CLI and the MCP server are generated from.","license":{"name":"Proprietary"}},"servers":[{"url":"/","description":"This Deutsche Cloud installation"}],"tags":[{"name":"Compute","description":"Compute operations under /ec2/api"},{"name":"Auto Scaling","description":"Auto Scaling operations under /autoscaling/api"},{"name":"Load balancing","description":"Load balancing operations under /lb/api"},{"name":"Postgres","description":"Postgres operations under /rds/api"},{"name":"MySQL","description":"MySQL operations under /mysql/api"},{"name":"Document Database","description":"Document Database operations under /docdb/api"},{"name":"RabbitMQ","description":"RabbitMQ operations under /rabbitmq/api"},{"name":"Apache Kafka","description":"Apache Kafka operations under /kafka/api"},{"name":"Caches","description":"Caches operations under /cache/api"},{"name":"File Storage","description":"File Storage operations under /efs/api"},{"name":"Kubernetes","description":"Kubernetes operations under /eks/api"},{"name":"Queues","description":"Queues operations under /queue/api"},{"name":"Schedules","description":"Schedules operations under /scheduler/api"},{"name":"Error Tracking","description":"Error Tracking operations under /errors/api"},{"name":"Event bus","description":"Event bus operations under /events/api"},{"name":"Functions","description":"Functions operations under /functions/api"},{"name":"Sandboxes","description":"Sandboxes operations under /sandbox/api"},{"name":"Cloud shell","description":"Cloud shell operations under /cloudshell/api"},{"name":"Object Storage","description":"Object Storage operations under /s3/api"},{"name":"Git","description":"Git operations under /git/api"},{"name":"KMS","description":"KMS operations under /kms/api"},{"name":"Secrets","description":"Secrets operations under /secrets/api"},{"name":"Container registry","description":"Container registry operations under /ecr/api"},{"name":"npm registry","description":"npm registry operations under /npm/api"},{"name":"Billing","description":"Billing operations under /billing/api"},{"name":"Identity","description":"Identity operations under /iam/api"},{"name":"DNS","description":"DNS operations under /dns/api"},{"name":"CI","description":"CI operations under /ci/api"},{"name":"Apps","description":"Apps operations under /deploy/api"},{"name":"Monitoring","description":"Monitoring operations under /monitoring/api"},{"name":"VPN","description":"VPN operations under /vpn/api"},{"name":"Privacy VPN","description":"Privacy VPN operations under /privacyvpn/api"},{"name":"Email","description":"Email operations under /email/api"},{"name":"Tags & saved views","description":"Tags & saved views operations under /tags/api"},{"name":"Projects","description":"Projects operations under /projects/api"},{"name":"AI Models","description":"AI Models operations under /ai/api"},{"name":"CDN","description":"CDN operations under /cdn/api"},{"name":"Web application firewall","description":"Web application firewall operations under /waf/api"},{"name":"Service quotas","description":"Service quotas operations under /quotas/api"},{"name":"Security Posture","description":"Security Posture operations under /posture/api"}],"security":[{"EwsAccessKey":[]}],"components":{"securitySchemes":{"EwsAccessKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Deutsche Cloud access key authentication. Format: `EWS-ACCESS-KEY EWS1XXXXXXXXXXXXXXXX:<40-char-secret>`. Generate access keys in the IAM console under Access Keys."}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"const":true},"data":{}},"required":["success"]},"ErrorResponse":{"type":"object","properties":{"success":{"const":false},"error":{"type":"string","description":"Human-readable error message"}},"required":["success","error"]}}},"paths":{"/ai/api/assistant-models":{"get":{"operationId":"ai.assistant-models.list","summary":"List the models the organization can choose for the assistant, and what Auto is now","description":"`ai:Chat` List the models the organization can choose for the assistant, and what Auto is now. Read live from the provider’s API (cached 5 minutes). `auto` is the model Auto resolves to right now. Only models the provider reports as hosted in Germany or the EU are listed.","tags":["AI Models"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:Chat","x-ews-mutates":false,"x-ews-sensitive":false}},"/ai/api/model-access":{"get":{"operationId":"ai.model-access.get","summary":"Read the organization’s model access settings and effective limits","description":"`ai:ListModels` Read the organization’s model access settings and effective limits.","tags":["AI Models"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:ListModels","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ai.model-access.update","summary":"Set the residency ceiling, allow-list, rate limits, monthly spend cap or prompt logging","description":"`ai:ConfigureModelAccess` Set the residency ceiling, allow-list, rate limits, monthly spend cap or prompt logging. Only the fields sent change. Prompt logging needs a KMS encrypt/decrypt key; bodies are sealed under it and kept 30 days.","tags":["AI Models"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"residencyCeiling":{"description":"The most the organization lets through: eu (EU providers processing in the EU), eu-processed (also non-EU providers processing in the EU) or any","type":"string","enum":["eu","eu-processed","any"]},"allowListEnabled":{"description":"Only the models in allowedModels may be used (otherwise every model within the residency ceiling)","type":"boolean"},"allowedModels":{"description":"Model ids on the allow-list","maxItems":200,"type":"array","items":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9.-]*[a-z0-9]$"}},"requestsPerMinute":{"description":"Requests per minute for the organization; null for the default (600)","anyOf":[{"type":"integer","minimum":1,"maximum":100000},{"type":"null"}]},"requestsPerMinutePerKey":{"description":"Requests per minute per access key; null for no per-key limit","anyOf":[{"type":"integer","minimum":1,"maximum":100000},{"type":"null"}]},"monthlySpendCapEur":{"description":"Hard monthly spend cap in EUR (calendar month, UTC); null for none","anyOf":[{"type":"number","minimum":0,"maximum":1000000},{"type":"null"}]},"promptLogging":{"description":"Store prompt and response bodies, encrypted under a KMS key, for 30 days","type":"boolean"},"promptLogKeyId":{"description":"The KMS key to seal prompt logs under (default: the first enabled encrypt/decrypt key)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:ConfigureModelAccess","x-ews-mutates":true,"x-ews-sensitive":false}},"/ai/api/models":{"get":{"operationId":"ai.models.list","summary":"List the models, whether this organization may use each, and their prices","description":"`ai:ListModels` List the models, whether this organization may use each, and their prices. Each entry says whether the organization’s model access allows it (`available`) and whether the caller’s IAM allows ai:InvokeModel on it (`canInvoke`). Prices are EUR per million tokens.","tags":["AI Models"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:ListModels","x-ews-mutates":false,"x-ews-sensitive":false}},"/ai/api/settings":{"get":{"operationId":"ai.settings.get","summary":"Read the assistant’s switches for the organization","description":"`ai:Chat` Read the assistant’s switches for the organization.","tags":["AI Models"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:Chat","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ai.settings.update","summary":"Turn the assistant’s live-data reading or actions on or off, or choose its model","description":"`ai:ConfigureSettings` Turn the assistant’s live-data reading or actions on or off, or choose its model. Only the fields sent change. Applies to every member of the organization.","tags":["AI Models"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aiAnswerQuestions":{"description":"The console assistant for the whole organization; off, the chat API answers 403","type":"boolean"},"aiReadLiveData":{"description":"Let the assistant read live resources, with the asking user’s permissions","type":"boolean"},"aiExecuteActions":{"description":"Let the assistant carry out changes, with the asking user’s permissions","type":"boolean"},"aiAssistantModel":{"description":"The assistant’s model: `auto` (the default) or an id from `ai assistant-models list`; checked against that live list","type":"string","minLength":1,"maxLength":200}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:ConfigureSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/ai/api/usage":{"get":{"operationId":"ai.usage.list","summary":"Per-model totals and the request log for a time range","description":"`ai:GetUsage` Per-model totals and the request log for a time range. Default range: the last 24 hours. Rows are kept 90 days.","tags":["AI Models"],"parameters":[{"name":"from","in":"query","required":false,"schema":{"description":"Start, ISO 8601 (default: 24 hours ago)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"schema":{"description":"End, ISO 8601 (default: now)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"model","in":"query","required":false,"schema":{"description":"Only this model","type":"string","minLength":2,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9.-]*[a-z0-9]$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"Log rows to return (default 100)","type":"integer","minimum":1,"maximum":500}},{"name":"before","in":"query","required":false,"schema":{"description":"Rows older than this (the createdAt of the last row of the previous page)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:GetUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/ai/api/usage/{id}/prompt":{"get":{"operationId":"ai.usage.get-prompt","summary":"Read the logged prompt and response of one request","description":"`ai:GetPromptLogs` Read the logged prompt and response of one request. Only exists for requests made while prompt logging was on, for 30 days. Every read is audited.","tags":["AI Models"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ai:GetPromptLogs","x-ews-mutates":false,"x-ews-sensitive":true}},"/autoscaling/api/groups":{"get":{"operationId":"autoscaling.groups.list","summary":"List auto scaling groups with their machine counts","description":"`autoscaling:DescribeAutoScalingGroups` List auto scaling groups with their machine counts.","tags":["Auto Scaling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DescribeAutoScalingGroups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"autoscaling.groups.create","summary":"Create a group; it launches up to its desired capacity within a minute","description":"`autoscaling:CreateAutoScalingGroup` Create a group; it launches up to its desired capacity within a minute. Also needs ec2:RunInstances: the group launches machines on its creator’s authority. Machines are spread evenly across availabilityZoneIds and registered with every load balancer in loadBalancerIds once running.","tags":["Auto Scaling"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"regionId":{"type":"string","minLength":1,"maxLength":32},"launchTemplateId":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"},"launchTemplateVersion":{"description":"$Default (default), $Latest, or a version number","anyOf":[{"type":"string","const":"$Default"},{"type":"string","const":"$Latest"},{"type":"string","pattern":"^[1-9][0-9]{0,5}$"}]},"minSize":{"type":"integer","minimum":0,"maximum":100},"maxSize":{"type":"integer","minimum":0,"maximum":100},"desiredCapacity":{"description":"Default: minSize","type":"integer","minimum":0,"maximum":100},"availabilityZoneIds":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"description":"Zones to spread machines across evenly, e.g. [\"de1a\",\"de1b\"]"},"vpcId":{"description":"Default: the region’s default VPC","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"subnetIds":{"description":"At most one per zone; machines in that zone take an address in it","maxItems":8,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"loadBalancerIds":{"description":"Every machine in service is a target of each","maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"healthCheckType":{"description":"ec2 (machine up, default) or lb (also passes its load balancers’ health checks)","type":"string","enum":["ec2","lb"]},"healthCheckGracePeriodSeconds":{"description":"Default 300","type":"integer","minimum":0,"maximum":7200},"defaultCooldownSeconds":{"description":"Default 300","type":"integer","minimum":0,"maximum":3600},"defaultInstanceWarmupSeconds":{"description":"Seconds before a new machine’s metrics count; default 300","type":"integer","minimum":0,"maximum":3600},"instanceTypes":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z0-9-]{2,24}$"},"description":"Instance types to use, in order, when the first choice is sold out (like AWS overrides), e.g. performance-4. Same CPU architecture as the template; the provider’s own type names are still accepted, deprecated"},"capacityFallback":{"description":"Stock fallback; default { otherZones: true, equivalentTypes: false }: a zone that is sold out is skipped for the group’s other zones","type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"]},"deferScaleInUntilPaidHour":{"type":"boolean","description":"Cloud machines are billed per started hour: a machine picked for scale-in keeps serving until the last 5 minutes of its paid hour, and the one whose hour ends first is picked. On own hosts (no hourly increment) it leaves at once. Default false"}},"required":["name","regionId","launchTemplateId","minSize","maxSize","availabilityZoneIds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CreateAutoScalingGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}":{"get":{"operationId":"autoscaling.groups.get","summary":"Describe a group: machines, policies, schedules, refreshes and activity","description":"`autoscaling:DescribeAutoScalingGroups` Describe a group: machines, policies, schedules, refreshes and activity.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DescribeAutoScalingGroups","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"autoscaling.groups.update","summary":"Change sizes, zones, balancers, health checks, template version or suspended processes","description":"`autoscaling:UpdateAutoScalingGroup` Change sizes, zones, balancers, health checks, template version or suspended processes.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"launchTemplateVersion":{"anyOf":[{"type":"string","const":"$Default"},{"type":"string","const":"$Latest"},{"type":"string","pattern":"^[1-9][0-9]{0,5}$"}]},"minSize":{"type":"integer","minimum":0,"maximum":100},"maxSize":{"type":"integer","minimum":0,"maximum":100},"desiredCapacity":{"type":"integer","minimum":0,"maximum":100},"availabilityZoneIds":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"}},"subnetIds":{"maxItems":8,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"loadBalancerIds":{"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"healthCheckType":{"type":"string","enum":["ec2","lb"]},"healthCheckGracePeriodSeconds":{"type":"integer","minimum":0,"maximum":7200},"defaultCooldownSeconds":{"type":"integer","minimum":0,"maximum":3600},"defaultInstanceWarmupSeconds":{"type":"integer","minimum":0,"maximum":3600},"suspendedProcesses":{"description":"Paused processes, the whole set: Launch, Terminate, HealthCheck, ReplaceUnhealthy, AlarmNotification, ScheduledActions","type":"array","items":{"type":"string","enum":["Launch","Terminate","HealthCheck","ReplaceUnhealthy","AlarmNotification","ScheduledActions"]}},"instanceTypes":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z0-9-]{2,24}$"},"description":"Instance types to use, in order, when the first choice is sold out (like AWS overrides), e.g. performance-4. Same CPU architecture as the template; the provider’s own type names are still accepted, deprecated"},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"],"description":"What a create may fall back to when the provider is out of stock"},"deferScaleInUntilPaidHour":{"type":"boolean","description":"Cloud machines are billed per started hour: a machine picked for scale-in keeps serving until the last 5 minutes of its paid hour, and the one whose hour ends first is picked. On own hosts (no hourly increment) it leaves at once. Default false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:UpdateAutoScalingGroup","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"autoscaling.groups.delete","summary":"Delete a group: its machines are deregistered and terminated, then the group goes","description":"`autoscaling:DeleteAutoScalingGroup` Delete a group: its machines are deregistered and terminated, then the group goes.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DeleteAutoScalingGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/desired-capacity":{"put":{"operationId":"autoscaling.groups.set-desired-capacity","summary":"Set how many machines the group runs (within min and max)","description":"`autoscaling:SetDesiredCapacity` Set how many machines the group runs (within min and max).","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"desiredCapacity":{"type":"integer","minimum":0,"maximum":100}},"required":["desiredCapacity"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:SetDesiredCapacity","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instance-refreshes":{"post":{"operationId":"autoscaling.instance-refreshes.start","summary":"Start replacing every machine not on the group’s current template version","description":"`autoscaling:StartInstanceRefresh` Start replacing every machine not on the group’s current template version. One extra machine is launched first; an old one is terminated only after the new one has served for the warmup. The group never drops below its desired capacity.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceWarmupSeconds":{"description":"Seconds a new machine serves before the next old one goes; default the group’s","type":"integer","minimum":0,"maximum":3600}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:StartInstanceRefresh","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instance-refreshes/cancel":{"post":{"operationId":"autoscaling.instance-refreshes.cancel","summary":"Stop the refresh in progress where it is","description":"`autoscaling:CancelInstanceRefresh` Stop the refresh in progress where it is.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CancelInstanceRefresh","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instances/{instanceId}/complete-lifecycle-action":{"post":{"operationId":"autoscaling.groups.complete-lifecycle-action","summary":"Let a machine held by the termination lifecycle hook be terminated now","description":"`autoscaling:CompleteLifecycleAction` Let a machine held by the termination lifecycle hook be terminated now.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"instanceId","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"result":{"description":"Default CONTINUE; for a termination hook both terminate the machine now","type":"string","enum":["CONTINUE","ABANDON"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CompleteLifecycleAction","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instances/{instanceId}/lifecycle-heartbeat":{"post":{"operationId":"autoscaling.groups.record-lifecycle-heartbeat","summary":"Hold a leaving machine for one more heartbeat timeout (at most 48 h in all)","description":"`autoscaling:RecordLifecycleActionHeartbeat` Hold a leaving machine for one more heartbeat timeout (at most 48 h in all).","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"instanceId","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:RecordLifecycleActionHeartbeat","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instances/{instanceId}/protection":{"put":{"operationId":"autoscaling.groups.set-instance-protection","summary":"Protect a machine from scale-in, or lift the protection","description":"`autoscaling:SetInstanceProtection` Protect a machine from scale-in, or lift the protection. A machine can protect itself while busy (a CI runner during a job) through its instance identity: `PUT /api/instance/v1/autoscaling/protection`. A group whose excess machines are all protected stays above its desired capacity (scaleInBlockedByProtection in describe).","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"instanceId","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protectedFromScaleIn":{"type":"boolean","description":"Scale-in never picks a protected machine"}},"required":["protectedFromScaleIn"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:SetInstanceProtection","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/instances/{instanceId}/terminate":{"post":{"operationId":"autoscaling.groups.terminate-instance","summary":"Terminate one machine; the group replaces it unless told to shrink","description":"`autoscaling:TerminateInstanceInAutoScalingGroup` Terminate one machine; the group replaces it unless told to shrink.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"instanceId","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decrementDesiredCapacity":{"description":"true: the group shrinks by one; false (default): the group replaces it","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:TerminateInstanceInAutoScalingGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/lifecycle-hooks":{"put":{"operationId":"autoscaling.groups.put-lifecycle-hook","summary":"Create or replace the termination lifecycle hook: a leaving machine waits until it is done","description":"`autoscaling:PutLifecycleHook` Create or replace the termination lifecycle hook: a leaving machine waits until it is done. The machine reads its state at `GET /api/instance/v1/autoscaling/lifecycle` and completes it with `POST /api/instance/v1/autoscaling/lifecycle/complete`, or the API does. One hook per transition.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"transition":{"description":"terminating (the only one today): a leaving machine waits; default terminating","type":"string","enum":["terminating"]},"heartbeatTimeoutSeconds":{"description":"How long a leaving machine is held without a heartbeat; default 3600. Heartbeats extend it, up to 48 h","type":"integer","minimum":30,"maximum":7200},"defaultResult":{"description":"What the timeout counts as; for a termination hook both terminate. Default CONTINUE","type":"string","enum":["CONTINUE","ABANDON"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:PutLifecycleHook","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/lifecycle-hooks/{hookName}":{"delete":{"operationId":"autoscaling.groups.delete-lifecycle-hook","summary":"Delete a lifecycle hook; machines it holds go on to termination","description":"`autoscaling:DeleteLifecycleHook` Delete a lifecycle hook; machines it holds go on to termination.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"hookName","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DeleteLifecycleHook","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/policies":{"put":{"operationId":"autoscaling.policies.put-target-tracking+put-step","summary":"put-target-tracking, put-step — selected by the request body","description":"Several operations share this method and path; the handler picks one from the body.\n- `autoscaling.policies.put-target-tracking` — `autoscaling:PutScalingPolicy` Create or replace a target-tracking policy (keep a metric near a value). Capacity follows ceil(warm machines measured × value / target); machines still warming are not measured and not counted twice. Scale-out is immediate; scale-in waits until nothing is warming, for the group’s cooldown and for the metric to be 10 % under target.\n- `autoscaling.policies.put-step` — `autoscaling:PutScalingPolicy` Create or replace a step policy driven by any monitoring alarm.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"target_tracking"},"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"enabled":{"type":"boolean"},"metric":{"type":"string","enum":["cpu_percent","network_in_bps","network_out_bps"],"description":"cpu_percent is 0–100 % of the machine, whatever its vCPU count"},"targetValue":{"type":"number","exclusiveMinimum":0},"disableScaleIn":{"type":"boolean"}},"required":["type","name","metric","targetValue"]},{"type":"object","properties":{"type":{"type":"string","const":"step"},"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"enabled":{"type":"boolean"},"alarmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A monitoring alarm; its ALARM state triggers the steps"},"adjustmentType":{"type":"string","enum":["change_in_capacity","exact_capacity","percent_change_in_capacity"]},"stepAdjustments":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"lowerBound":{"type":["number","null"]},"upperBound":{"type":["number","null"]},"adjustment":{"type":"integer","minimum":-100,"maximum":100}},"required":["lowerBound","upperBound","adjustment"]},"description":"[{lowerBound, upperBound, adjustment}] over metric − threshold, [lower, upper)"},"cooldownSeconds":{"type":"integer","minimum":0,"maximum":3600}},"required":["type","name","alarmId","adjustmentType","stepAdjustments"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:PutScalingPolicy","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-operations":["autoscaling.policies.put-target-tracking","autoscaling.policies.put-step"]}},"/autoscaling/api/groups/{id}/policies/{policyId}":{"delete":{"operationId":"autoscaling.policies.delete","summary":"Delete a scaling policy","description":"`autoscaling:DeletePolicy` Delete a scaling policy.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","pattern":"^asp-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DeletePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/scheduled-actions":{"put":{"operationId":"autoscaling.scheduled-actions.put","summary":"Create or replace a scheduled action","description":"`autoscaling:PutScheduledUpdateGroupAction` Create or replace a scheduled action.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"recurrence":{"description":"Five-field cron, UTC, e.g. \"0 7 * * 1-5\"","type":"string","maxLength":100},"startTime":{"description":"One-off: when. Recurring: not before","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endTime":{"description":"Recurring: not after","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"minSize":{"type":"integer","minimum":0,"maximum":100},"maxSize":{"type":"integer","minimum":0,"maximum":100},"desiredCapacity":{"type":"integer","minimum":0,"maximum":100}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:PutScheduledUpdateGroupAction","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/groups/{id}/scheduled-actions/{actionId}":{"delete":{"operationId":"autoscaling.scheduled-actions.delete","summary":"Delete a scheduled action","description":"`autoscaling:DeleteScheduledAction` Delete a scheduled action.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^asg-[0-9a-f]{8}$"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^asa-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DeleteScheduledAction","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/launch-templates":{"get":{"operationId":"autoscaling.launch-templates.list","summary":"List launch templates","description":"`autoscaling:DescribeLaunchTemplates` List launch templates.","tags":["Auto Scaling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DescribeLaunchTemplates","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"autoscaling.launch-templates.create","summary":"Create a launch template (its version 1)","description":"`autoscaling:CreateLaunchTemplate` Create a launch template (its version 1).","tags":["Auto Scaling"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"regionId":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":255},"versionDescription":{"type":"string","maxLength":255},"spec":{"type":"object","properties":{"serverType":{"type":"string","minLength":1,"maxLength":32},"sizeClass":{"type":"string","enum":["s-2","s-4","s-8","s-16","m-4","d-2","d-8","a-2","a-4","a-8","a-16"],"description":"A size class instead of a provider type: s-2 (2 vCPU / 4 GiB), s-4 (4 / 8), s-8 (8 / 16), s-16 (16 / 32), m-4 (4 / 32), d-2 (2 dedicated / 8), d-8 (8 dedicated / 32), a-2, a-4, a-8, a-16 (ARM, as s-*); it becomes the smallest type of your provider that fits"},"imageId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"machineImageId":{"type":"string","pattern":"^ewi-[0-9a-f]{6,32}$"},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sshKeyPairId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"userData":{"type":"string","maxLength":32768},"securityGroupIds":{"maxItems":16,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"enablePublicIpv4":{"type":"boolean"},"osPatching":{"type":"boolean"},"connect":{"type":"boolean"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"iamRoleName":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[\\w+=,.@-]+$","description":"IAM role the machine acts as (needs iam:PassRole on it): it gets 60-minute credentials for it through its instance identity (`ews-instance credentials`), with no key in user data"},"requiredHostTags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9-]+(:[a-z0-9.-]+)?$"}}},"additionalProperties":false,"description":"What machines are made from: serverType, imageId or machineImageId, vpcId, sshKeyPairId, userData, securityGroupIds, enablePublicIpv4, osPatching, tags"}},"required":["name","regionId","spec"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CreateLaunchTemplate","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/launch-templates/{id}":{"get":{"operationId":"autoscaling.launch-templates.get","summary":"Describe a launch template and every version of it","description":"`autoscaling:DescribeLaunchTemplates` Describe a launch template and every version of it.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DescribeLaunchTemplates","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"autoscaling.launch-templates.set-default-version","summary":"Change which version $Default means","description":"`autoscaling:CreateLaunchTemplateVersion` Change which version $Default means.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"defaultVersion":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The version `$Default` groups launch"}},"required":["defaultVersion"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CreateLaunchTemplateVersion","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"autoscaling.launch-templates.delete","summary":"Delete a launch template no group uses","description":"`autoscaling:DeleteLaunchTemplate` Delete a launch template no group uses.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:DeleteLaunchTemplate","x-ews-mutates":true,"x-ews-sensitive":false}},"/autoscaling/api/launch-templates/{id}/versions":{"post":{"operationId":"autoscaling.launch-templates.create-version","summary":"Add a version; groups on $Latest (or $Default, with makeDefault) pick it up","description":"`autoscaling:CreateLaunchTemplateVersion` Add a version; groups on $Latest (or $Default, with makeDefault) pick it up. Machines already running keep the version they were launched from. Start an instance refresh to roll a group onto it.","tags":["Auto Scaling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","maxLength":255},"spec":{"type":"object","properties":{"serverType":{"type":"string","minLength":1,"maxLength":32},"sizeClass":{"type":"string","enum":["s-2","s-4","s-8","s-16","m-4","d-2","d-8","a-2","a-4","a-8","a-16"],"description":"A size class instead of a provider type: s-2 (2 vCPU / 4 GiB), s-4 (4 / 8), s-8 (8 / 16), s-16 (16 / 32), m-4 (4 / 32), d-2 (2 dedicated / 8), d-8 (8 dedicated / 32), a-2, a-4, a-8, a-16 (ARM, as s-*); it becomes the smallest type of your provider that fits"},"imageId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"machineImageId":{"type":"string","pattern":"^ewi-[0-9a-f]{6,32}$"},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sshKeyPairId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"userData":{"type":"string","maxLength":32768},"securityGroupIds":{"maxItems":16,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"enablePublicIpv4":{"type":"boolean"},"osPatching":{"type":"boolean"},"connect":{"type":"boolean"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"iamRoleName":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[\\w+=,.@-]+$","description":"IAM role the machine acts as (needs iam:PassRole on it): it gets 60-minute credentials for it through its instance identity (`ews-instance credentials`), with no key in user data"},"requiredHostTags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9-]+(:[a-z0-9.-]+)?$"}}},"additionalProperties":false},"makeDefault":{"description":"Make it the version `$Default` groups launch","type":"boolean"}},"required":["spec"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"autoscaling:CreateLaunchTemplateVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/account":{"get":{"operationId":"billing.account.get","summary":"The billing account: company name, invoice address, VAT ID, invoice e-mail","description":"`billing:GetBillingAccount` The billing account: company name, invoice address, VAT ID, invoice e-mail.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBillingAccount","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"billing.account.update","summary":"Change the company name, invoice address, VAT ID or invoice e-mail","description":"`billing:UpdateBillingAccount` Change the company name, invoice address, VAT ID or invoice e-mail. Applies to invoices issued from now on; issued invoices keep what they said. A changed VAT ID is checked for its member state’s format and against VIES: one VIES does not know is refused (400, field vatNumber); when VIES cannot be reached the ID is saved with vatNumberStatus unavailable, every later save checks it again until VIES confirms it, and until then invoices treat it as no VAT ID (no reverse charge for an EU customer outside Germany; a German customer pays German VAT either way). country is one of the listed ISO codes; postalCode must fit that country (DE: five digits). Send every field. billingEmail is recorded for invoice e-mails, which are not sent yet.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"type":"string","minLength":2,"maxLength":200},"vatNumber":{"type":"string","maxLength":20},"addressLine1":{"type":"string","minLength":2,"maxLength":200},"addressLine2":{"type":"string","maxLength":200},"postalCode":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":100},"country":{"type":"string","pattern":"^[A-Za-z]{2}$"},"billingEmail":{"anyOf":[{"type":"string","const":""},{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}]}},"required":["companyName","addressLine1","postalCode","city","country"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:UpdateBillingAccount","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/budgets":{"get":{"operationId":"billing.budgets.list","summary":"List budgets","description":"`billing:GetBudgets` List budgets.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"billing.budgets.create","summary":"Create a budget","description":"`billing:CreateBudget` Create a budget.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"amountCents":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"period":{"type":"string","enum":["monthly","quarterly","annual"]},"scope":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"organization"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"project"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A saved view (a saved tag query; GET /tags/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"resourceProject"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A project: what lives in it (GET /projects/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"tags"},"clauses":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["key","values"]}}},"required":["type","clauses"]}]},"serviceFilter":{"type":"array","items":{"type":"string"}},"alertThresholds":{"type":"array","items":{"type":"integer","minimum":1,"maximum":1000}},"notificationEmails":{"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"action":{"description":"Let the budget propose stopping non-production resources: {thresholdPercent (default 100), selector (tag clauses, default environment in dev/development/test/staging/preview)}. A person approves each proposal.","anyOf":[{"type":"object","properties":{"thresholdPercent":{"default":100,"type":"integer","minimum":1,"maximum":1000},"selector":{"default":[{"key":"environment","values":["dev","development","test","staging","preview"]}],"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["key","values"]}}}},{"type":"null"}]},"forecastThresholds":{"anyOf":[{"maxItems":10,"type":"array","items":{"type":"integer","minimum":1,"maximum":1000},"description":"Monthly budgets: also alert (mail and the ews.billing \"Budget Threshold Crossed\" event, kind forecast) when the month-end forecast reaches these percentages, e.g. [100]"},{"type":"null"}]}},"required":["name","amountCents","period"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:CreateBudget","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/budgets/{id}":{"get":{"operationId":"billing.budgets.get","summary":"Describe one budget","description":"`billing:GetBudgets` Describe one budget.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"billing.budgets.update","summary":"Update a budget","description":"`billing:UpdateBudget` Update a budget.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"amountCents":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"period":{"type":"string","enum":["monthly","quarterly","annual"]},"scope":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"organization"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"project"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A saved view (a saved tag query; GET /tags/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"resourceProject"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A project: what lives in it (GET /projects/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"tags"},"clauses":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["key","values"]}}},"required":["type","clauses"]}]},"serviceFilter":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"alertThresholds":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":1,"maximum":1000}},{"type":"null"}]},"notificationEmails":{"anyOf":[{"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},{"type":"null"}]},"action":{"description":"The budget’s action; null removes it (the budget then only notifies)","anyOf":[{"type":"object","properties":{"thresholdPercent":{"default":100,"type":"integer","minimum":1,"maximum":1000},"selector":{"default":[{"key":"environment","values":["dev","development","test","staging","preview"]}],"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["key","values"]}}}},{"type":"null"}]},"forecastThresholds":{"anyOf":[{"maxItems":10,"type":"array","items":{"type":"integer","minimum":1,"maximum":1000},"description":"Monthly budgets: also alert (mail and the ews.billing \"Budget Threshold Crossed\" event, kind forecast) when the month-end forecast reaches these percentages, e.g. [100]"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:UpdateBudget","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"billing.budgets.delete","summary":"Delete a budget","description":"`billing:DeleteBudget` Delete a budget.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:DeleteBudget","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/budgets/{id}/action-preview":{"get":{"operationId":"billing.budgets.action-preview","summary":"What the budget’s action would propose to stop right now","description":"`billing:GetBudgets` What the budget’s action would propose to stop right now. Running instances and databases, and autoscaling groups, inside the budget’s scope whose tags match the action’s selector, never those tagged budget-action=keep. Kubernetes nodes are left to their node groups; autoscaling members are covered by scaling their group to 0. Each with the hourly charge that stops.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/budgets/action-proposals":{"get":{"operationId":"billing.budget-proposals.list","summary":"List budget action proposals, newest first","description":"`billing:GetBudgets` List budget action proposals, newest first. `status`: pending (waiting for approval), executing, done (each item carries `result`), dismissed, expired (the period ended undecided).","tags":["Billing"],"parameters":[{"name":"budgetId","in":"query","required":false,"schema":{"description":"Only this budget’s proposals","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/budgets/action-proposals/{id}/approve":{"post":{"operationId":"billing.budget-proposals.approve","summary":"Approve a proposal: stop or scale down every resource it names","description":"`billing:ApproveBudgetAction` Approve a proposal: stop or scale down every resource it names. Each stop runs through its own route with your credential, so it also needs ec2:StopInstances, rds:StopDBInstance or autoscaling:UpdateAutoScalingGroup on that resource and is audited as yours. A resource someone already stopped is `skipped`. Only a pending proposal can be approved, once (409 otherwise). Start the resources again, or set the group’s sizes back to `previous`, to undo.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:ApproveBudgetAction","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/budgets/action-proposals/{id}/dismiss":{"post":{"operationId":"billing.budget-proposals.dismiss","summary":"Dismiss a proposal: nothing is stopped this period","description":"`billing:ApproveBudgetAction` Dismiss a proposal: nothing is stopped this period.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:ApproveBudgetAction","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/budgets/scope-preview":{"post":{"operationId":"billing.budgets.scope-preview","summary":"Count the resources a scope would cover, before saving it","description":"`billing:GetBudgets` Count the resources a scope would cover, before saving it. A read behind a POST: the scope is a nested structure, and encoding it into a query string would mean a second parser for the same shape. Nothing is written. Also requires tags:ListTags — it reads tag membership.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"organization"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"project"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A saved view (a saved tag query; GET /tags/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"resourceProject"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","projectId"],"description":"A project: what lives in it (GET /projects/api/projects lists them)"},{"type":"object","properties":{"type":{"type":"string","const":"tags"},"clauses":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["key","values"]}}},"required":["type","clauses"]}]}},"required":["scope"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/budgets/status":{"get":{"operationId":"billing.budgets.status","summary":"List budgets with current spend, scope size and fired alerts","description":"`billing:GetBudgets` List budgets with current spend, scope size and fired alerts. Reports whether a budget’s scope currently selects no billable resource — a budget guarding an empty set looks identical to one that is guarding something.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBudgets","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-explorer/accounting-export":{"get":{"operationId":"billing.costs.accounting-export","summary":"A month or a range of days as a DATEV Buchungsstapel (EXTF) for the tax advisor","description":"`billing:GetCostAndUsage` A month or a range of days as a DATEV Buchungsstapel (EXTF) for the tax advisor. DATEV-Format Buchungsstapel: the EXTF header record (version 700, category 21, format 13; Berater- and Mandantennummer, fiscal year start and account length from the cost-report settings, empty until set; Datum vom/bis = the range; not fixed), then the 125 standard columns. Windows-1252, semicolons, decimal comma, CRLF. Give month (YYYY-MM) or start and end (YYYY-MM-DD, inclusive, UTC); a range across two fiscal years is refused (400). One row per month × cost centre × project × service, net of discounts and before VAT; each credit an H row; KOST1 is the cost-centre tag (default cost-center), KOST2 the project, a resource in two projects split evenly. Belegdatum and Leistungsdatum are the last day of service in that month inside the range, never a future day; a month not over yet says \"vorläufig\" in the Buchungstext. Cents are allocated by largest remainder so the rows sum exactly to the net. Konto and Gegenkonto come from the report settings unless given here.","tags":["Billing"],"parameters":[{"name":"month","in":"query","required":false,"schema":{"description":"The billing month, YYYY-MM; or give start and end","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},{"name":"start","in":"query","required":false,"schema":{"description":"First day of the range, YYYY-MM-DD (UTC), with end; instead of month","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"}},{"name":"end","in":"query","required":false,"schema":{"description":"Last day of the range, YYYY-MM-DD (UTC), inclusive","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"}},{"name":"kost1TagKey","in":"query","required":false,"schema":{"description":"Override the cost-centre tag for this export","type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},{"name":"konto","in":"query","required":false,"schema":{"description":"Override the expense account","type":"string","maxLength":20,"pattern":"^[0-9A-Za-z]*$"}},{"name":"gegenkonto","in":"query","required":false,"schema":{"description":"Override the creditor account","type":"string","maxLength":20,"pattern":"^[0-9A-Za-z]*$"}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-explorer/compare":{"post":{"operationId":"billing.costs.compare","summary":"The same usage priced at other clouds’ public list prices","description":"`billing:GetCostAndUsage` The same usage priced at other clouds’ public list prices. A read behind a POST. For the query’s window and filters: instance hours (matched to each provider’s cheapest machine of the same CPU class and architecture with at least the vCPUs and memory, named in `matches`), managed PostgreSQL node hours (matched to the provider’s cheapest managed PostgreSQL server with at least the vCPUs and memory: RDS, Azure Flexible Server, STACKIT Flex; counted at our price and named in `partial` where none is read), block and object storage GB-months, priced at each reference provider’s list price (`providers`: name, region, matched machines), read weekly from their public price lists with `pricesFrom` and `sources`; a provider without a verified price list says so in `missing`. The provider whose servers we resell is priced at its list price (what we bill divided by our markup, ×1 today) and its matches say so; it sells no managed PostgreSQL, so a database node is its bare server there. Usage that is metered and not charged yet is left out (`notChargedEur`); everything else (requests, tokens, traffic, other managed services’ nodes, …) is `notComparedEur`. No free tiers, commitments or discounts are applied anywhere.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"groupBy":{"default":{"dimension":"service"},"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["dimension"]},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}},"maxGroups":{"default":8,"type":"integer","minimum":1,"maximum":50}},"required":["start","end"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-explorer/export":{"post":{"operationId":"billing.costs.export","summary":"CSV of every (period, resource, usage type) row","description":"`billing:GetCostAndUsage` CSV of every (period, resource, usage type) row. Columns: period_start, service, service_name, usage_type, usage_type_name, resource_type, resource_id, resource_name, region, zone, projects, created_by, tags, quantity, unit, amount_eur (8 places, unrounded — sums reproduce the explorer exactly), runs_on. format=excel-de writes the same columns for a German Excel: semicolons, decimal commas, names in words, dates as DD.MM.YYYY, euros to the cent, UTF-8 with a BOM, CRLF.","tags":["Billing"],"parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["machine","excel-de"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"groupBy":{"default":{"dimension":"service"},"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["dimension"]},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}},"maxGroups":{"default":8,"type":"integer","minimum":1,"maximum":50}},"required":["start","end"]}}}},"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-explorer/lines":{"post":{"operationId":"billing.costs.lines","summary":"The usage lines behind a bar, a group or a resource","description":"`billing:GetCostAndUsage` The usage lines behind a bar, a group or a resource. One line per (resource, usage type, unit price): quantity, unit, rate, amount, first and last metered. Pass `bucket` (the ISO start of a bar) with its `granularity` to see one bar.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}},"bucket":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"limit":{"default":200,"type":"integer","minimum":1,"maximum":2000}},"required":["start","end"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-explorer/query":{"post":{"operationId":"billing.costs.query","summary":"Cost over time, grouped and filtered by any dimension","description":"`billing:GetCostAndUsage` Cost over time, grouped and filtered by any dimension. Dimensions: service, usageType, resource, resourceType, region, zone, project, tag (with tagKey), creator. Returns the stacked series, group totals vs the previous period of equal length, top movers by group and by resource, anomaly hints with the rule spelled out, a month-end forecast, discounts and credits, every billed resource with idle/detached/untagged hints, and the budgets. Amounts are EUR strings at 8 decimal places, exact. A read behind a POST: nothing is written.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"groupBy":{"default":{"dimension":"service"},"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["dimension"]},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}},"maxGroups":{"default":8,"type":"integer","minimum":1,"maximum":50}},"required":["start","end"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-findings":{"get":{"operationId":"billing.savings.list","summary":"What could be saved a month, resource by resource, with the action","description":"`billing:GetCostAndUsage` What could be saved a month, resource by resource, with the action. Kinds: idle-machine, oversized-machine, oversized-database, stopped-server, unattached-volume, unused-elastic-ip. Each finding: evidence (one sentence with the numbers), monthlySaving (EUR, 8 places, after discounts; 0 for elastic IPs, not billed yet), confidence (medium when memory is not measured), and the action as an API operation id with method, path and body. `rules` spells out every rule. Dismissed findings are listed separately with who kept them and why.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-findings/dismiss":{"post":{"operationId":"billing.savings.dismiss","summary":"Keep a finding, with a reason, for good or until a date","description":"`billing:DismissCostFinding` Keep a finding, with a reason, for good or until a date.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":3,"maxLength":300,"pattern":"^[a-z-]+:[^\\s]+$","description":"The finding’s key, e.g. idle-machine:ec2_instance/i-abc"},"reason":{"type":"string","minLength":3,"maxLength":500,"description":"Why it stays — shown to everyone"},"until":{"description":"Bring it back after this instant; omitted = keep for good","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["key","reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:DismissCostFinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-findings/restore":{"post":{"operationId":"billing.savings.restore","summary":"Bring a dismissed finding back","description":"`billing:DismissCostFinding` Bring a dismissed finding back.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":3,"maxLength":300,"pattern":"^[a-z-]+:[^\\s]+$","description":"The finding’s key, e.g. idle-machine:ec2_instance/i-abc"}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:DismissCostFinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-report":{"get":{"operationId":"billing.cost-report.get","summary":"Show the monthly cost report settings and the reports sent","description":"`billing:GetCostReportSettings` Show the monthly cost report settings and the reports sent. Sent on the 2nd at 08:00 German time for the month before, once per month. `effectiveRecipients` resolves the default (the owner plus the billing account’s invoice e-mail; a budget’s notification addresses get only that budget’s alerts).","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostReportSettings","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"billing.cost-report.update","summary":"Turn the monthly cost report on or off, or choose who gets it","description":"`billing:UpdateCostReportSettings` Turn the monthly cost report on or off, or choose who gets it.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"description":"Send the monthly cost report (default on)","type":"boolean"},"recipients":{"description":"Who gets it; null = the default: the owner plus the billing account’s invoice e-mail","anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},{"type":"null"}]},"accounting":{"description":"The accounting (DATEV-style) export: cost-centre tag and accounts","type":"object","properties":{"kost1TagKey":{"description":"The tag whose value is the cost centre (KOST1); null = cost-center","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},{"type":"null"}]},"konto":{"description":"Expense account written into Konto","anyOf":[{"type":"string","maxLength":20,"pattern":"^[0-9A-Za-z]*$"},{"type":"null"}]},"gegenkonto":{"description":"Creditor account written into Gegenkonto","anyOf":[{"type":"string","maxLength":20,"pattern":"^[0-9A-Za-z]*$"},{"type":"null"}]},"datev":{"description":"DATEV header: Beraternummer, Mandantennummer, fiscal year, account length","anyOf":[{"type":"object","properties":{"beraternummer":{"type":"integer","minimum":1001,"maximum":9999999,"description":"Beraternummer: the tax advisor’s DATEV number, 1001–9999999"},"mandantennummer":{"type":"integer","minimum":1,"maximum":99999,"description":"Mandantennummer: your client number at the tax advisor, 1–99999"},"fiscalYearStartMonth":{"type":"integer","minimum":1,"maximum":12,"description":"First month of the fiscal year, 1–12 (1 = January)"},"accountLength":{"type":"integer","minimum":4,"maximum":8,"description":"Sachkontenlänge: digits of a general-ledger account, 4–8 (usually 4)"}},"required":["beraternummer","mandantennummer","fiscalYearStartMonth","accountLength"]},{"type":"null"}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:UpdateCostReportSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-report/preview":{"get":{"operationId":"billing.cost-report.preview","summary":"A month’s report as data, without sending it","description":"`billing:GetCostAndUsage` A month’s report as data, without sending it.","tags":["Billing"],"parameters":[{"name":"period","in":"query","required":false,"schema":{"description":"The billing month, YYYY-MM (default: last month)","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/cost-report/send":{"post":{"operationId":"billing.cost-report.send","summary":"Send a month’s report now, with its CSVs (once per month unless `again`)","description":"`billing:SendCostReport` Send a month’s report now, with its CSVs (once per month unless `again`). `outcome`: sent, already_sent, disabled, no_recipients or failed. With `again: true` it goes out once more, at most every 10 minutes (429 otherwise). Attached: cost-lines-YYYY-MM.csv and accounting-YYYY-MM.csv.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"description":"The billing month, YYYY-MM (default: last month)","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"again":{"description":"Send even if this month already went out (at most every 10 minutes); default: only if it has not","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:SendCostReport","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-views":{"get":{"operationId":"billing.cost-views.list","summary":"List the saved views you can see (shared ones and your own)","description":"`billing:GetCostAndUsage` List the saved views you can see (shared ones and your own).","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"billing.cost-views.create","summary":"Save a cost explorer view","description":"`billing:CreateCostView` Save a cost explorer view. `state.range` is relative ({type: relative, preset: last-month | month-to-date | last-30-days | …}) so the view keeps its meaning, or fixed ({type: fixed, start, end}). `report: {enabled, recipients}` mails the view on the 2nd for the month before, with its CSV. Names are unique per organization (409).","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Unique in the organization"},"description":{"type":"string","maxLength":500},"state":{"type":"object","properties":{"range":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"relative"},"preset":{"type":"string","enum":["last-7-days","last-30-days","last-90-days","month-to-date","last-month","last-3-months","year-to-date"]}},"required":["type","preset"]},{"type":"object","properties":{"type":{"type":"string","const":"fixed"},"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["type","start","end"]}]},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"groupBy":{"default":{"dimension":"service"},"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["dimension"]},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}}},"required":["range"],"description":"The explorer question: range (relative preset or fixed dates), granularity, groupBy, filters — the same shapes as cost-explorer/query"},"shared":{"description":"Visible to everyone with billing:GetCostAndUsage (default) or only to its creator","type":"boolean"},"report":{"description":"Mail this view monthly, on the 2nd, for the month before","type":"object","properties":{"enabled":{"type":"boolean"},"recipients":{"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"description":"Who gets the view’s monthly mail (with its CSV)"}},"required":["enabled","recipients"]}},"required":["name","state"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:CreateCostView","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-views/{id}":{"get":{"operationId":"billing.cost-views.get","summary":"Describe one saved view, with the range it resolves to today","description":"`billing:GetCostAndUsage` Describe one saved view, with the range it resolves to today.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"billing.cost-views.update","summary":"Change a saved view, its sharing or its monthly mail","description":"`billing:UpdateCostView` Change a saved view, its sharing or its monthly mail.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Unique in the organization"},"description":{"type":"string","maxLength":500},"state":{"type":"object","properties":{"range":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"relative"},"preset":{"type":"string","enum":["last-7-days","last-30-days","last-90-days","month-to-date","last-month","last-3-months","year-to-date"]}},"required":["type","preset"]},{"type":"object","properties":{"type":{"type":"string","const":"fixed"},"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["type","start","end"]}]},"granularity":{"default":"day","type":"string","enum":["hour","day","month"]},"groupBy":{"default":{"dimension":"service"},"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["dimension"]},"filters":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["service","usageType","resource","resourceType","region","zone","project","resourceProject","tag","creator","provider"]},"tagKey":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","maxLength":256}},"exclude":{"type":"boolean"}},"required":["dimension","values"]}}},"required":["range"],"description":"The explorer question: range (relative preset or fixed dates), granularity, groupBy, filters — the same shapes as cost-explorer/query"},"shared":{"description":"Visible to everyone with billing:GetCostAndUsage (default) or only to its creator","type":"boolean"},"report":{"description":"Mail this view monthly, on the 2nd, for the month before","type":"object","properties":{"enabled":{"type":"boolean"},"recipients":{"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"description":"Who gets the view’s monthly mail (with its CSV)"}},"required":["enabled","recipients"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:UpdateCostView","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"billing.cost-views.delete","summary":"Delete a saved view","description":"`billing:DeleteCostView` Delete a saved view.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:DeleteCostView","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/cost-views/{id}/report":{"get":{"operationId":"billing.cost-views.report","summary":"A view’s monthly report for a month, as data, without sending it","description":"`billing:GetCostAndUsage` A view’s monthly report for a month, as data, without sending it.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"period","in":"query","required":false,"schema":{"description":"The billing month, YYYY-MM (default: last month)","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/credits":{"get":{"operationId":"billing.costs.credits","summary":"Credits and discounts granted to the organization, with what is left","description":"`billing:GetCostAndUsage` Credits and discounts granted to the organization, with what is left.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/estimate":{"post":{"operationId":"billing.estimates.create","summary":"Price an operation before running it (per hour, per month, monthly cap)","description":"`billing:EstimateCost` Price an operation before running it (per hour, per month, monthly cap). A read behind a POST: nothing is created. `operation` is the API operation id (ec2.instances.run, rds.instances.create, cache.clusters.create, vpn.endpoints.create, ec2.volumes.create, autoscaling.groups.create, lb.load-balancers.create, …) and `body` the request body it would get. Returns lines (per hour, per full month with the monthly cap applied, the cap), totals, `summary` (\"5,99 €/month max · 0,0096 €/h (excl. VAT)\", German number format as in the console; the numeric fields are plain decimals), pay-per-use unit prices, and lines marked `billed: false` for things that are not metered yet. Allowed with billing:EstimateCost or with the operation’s own action. `ews <command> --dry-run` prints this for the command it would run.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","minLength":3,"maxLength":96,"pattern":"^[a-z0-9-]+(\\.[a-z0-9-]+)+$","description":"API operation id, e.g. ec2.instances.run, rds.instances.create"},"body":{"default":{},"description":"The request body the operation would be sent","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["operation"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:EstimateCost","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/invoices":{"get":{"operationId":"billing.invoices.list","summary":"List invoices","description":"`billing:GetInvoices` List invoices.","tags":["Billing"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many, newest first (default 12)","type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetInvoices","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/invoices/{id}/pdf":{"get":{"operationId":"billing.invoices.pdf","summary":"An issued invoice as a PDF (A4)","description":"`billing:GetInvoices` An issued invoice as a PDF (A4). Rendered from the invoice as issued: the parties, VAT ID and rate snapshotted at issue time, the lines, the totals and how to pay. A draft has no number and no PDF (404).","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetInvoices","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/payment-methods":{"get":{"operationId":"billing.payment-methods.list","summary":"List payment methods","description":"`billing:GetPaymentMethods` List payment methods.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetPaymentMethods","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"billing.payment-methods.create","summary":"Add a payment method","description":"`billing:ManagePaymentMethods` Add a payment method.","tags":["Billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["bank_transfer"]}},"required":["type"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:ManagePaymentMethods","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/payment-methods/{id}":{"delete":{"operationId":"billing.payment-methods.delete","summary":"Remove a payment method","description":"`billing:ManagePaymentMethods` Remove a payment method.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:ManagePaymentMethods","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/payment-methods/{id}/default":{"patch":{"operationId":"billing.payment-methods.set-default","summary":"Make a payment method the default","description":"`billing:ManagePaymentMethods` Make a payment method the default.","tags":["Billing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:ManagePaymentMethods","x-ews-mutates":true,"x-ews-sensitive":false}},"/billing/api/resource-cost":{"get":{"operationId":"billing.costs.resource","summary":"What one resource costs: this month, last month, per hour now, monthly cap","description":"`billing:GetCostAndUsage` What one resource costs: this month, last month, per hour now, monthly cap. From the usage records the invoice is summed from. `currentHour` is null when the resource was not metered in the last two hours (stopped, deleted, or storage). `caps` has one row per machine (a 3-node database has three): charged this month against its monthly cap; once `reached`, its hours cost €0 until the month ends.","tags":["Billing"],"parameters":[{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["instance","database","cache","vpn","volume","distribution","webAcl"],"description":"instance, database, cache, vpn, volume, distribution (CDN) or webAcl (WAF)"}},{"name":"id","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"description":"The resource id, as its own service names it"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetCostAndUsage","x-ews-mutates":false,"x-ews-sensitive":false}},"/billing/api/summary":{"get":{"operationId":"billing.summary.get","summary":"Show the current billing summary","description":"`billing:GetBillingSummary` Show the current billing summary.","tags":["Billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"billing:GetBillingSummary","x-ews-mutates":false,"x-ews-sensitive":false}},"/cache/api/ca-bundle":{"get":{"operationId":"cache.clusters.ca-bundle","summary":"The platform CA (PEM) a TLS cache’s certificate chains to","description":"`cache:DescribeCacheClusters` The platform CA (PEM) a TLS cache’s certificate chains to.","tags":["Caches"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/cache/api/clusters":{"get":{"operationId":"cache.clusters.list","summary":"List caches","description":"`cache:DescribeCacheClusters` List caches.","tags":["Caches"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"cache.clusters.create","summary":"Create a cache","description":"`cache:CreateCacheCluster` Create a cache. Without vpcId the cache joins the default VPC, where deployed apps run. It is `creating` until the machine reports a healthy Valkey, usually within three minutes. The password is filed in Secrets as VALKEY_<IDENTIFIER>_PASSWORD.","tags":["Caches"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from node-types, e.g. performance-2. The provider’s own type names are still accepted, deprecated."},"evictionPolicy":{"default":"allkeys-lru","type":"string","enum":["noeviction","allkeys-lru","allkeys-lfu","volatile-lru","volatile-lfu","volatile-ttl"]},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"replicas":{"default":0,"description":"Replicas on other hosts, with Sentinel failover behind the same address (0: one node)","type":"integer","minimum":0,"maximum":2},"tls":{"default":true,"description":"TLS only on port 6380 (rediss://, platform CA), replication and Sentinels included. false: plaintext on 6379","type":"boolean"},"snapshotId":{"description":"Make the cache from this snapshot; needs cache:CreateCacheCluster on the snapshot","type":"string","pattern":"^ecs-[0-9a-f]{12}$"},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"],"description":"What a create may fall back to when the provider is out of stock"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"When the type is sold out where it goes and no fallback applies: fail at once (default), or wait as waiting-for-capacity (nothing built or billed) until it is back"},"capacityMaxWaitHours":{"type":"integer","minimum":1,"maximum":168,"description":"With onStockOut wait: give up after this many hours (1–168, default 24)"}},"required":["identifier","nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:CreateCacheCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/clusters/{id}":{"get":{"operationId":"cache.clusters.get","summary":"One cache, with its private address, usage and bound apps","description":"`cache:DescribeCacheClusters` One cache, with its private address, usage and bound apps.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheClusters","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"cache.clusters.modify","summary":"Change the eviction policy (applied live within a minute) or, on own hosts, the replica count","description":"`cache:ModifyCacheCluster` Change the eviction policy (applied live within a minute) or, on own hosts, the replica count. A replica change answers 202 with the cache `modifying` until new nodes are in sync and every node runs the new majority (a few minutes); `addressKind` says whether the cache can (`virtual-ip`).","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"evictionPolicy":{"type":"string","enum":["noeviction","allkeys-lru","allkeys-lfu","volatile-lru","volatile-lfu","volatile-ttl"]},"replicas":{"description":"Own hosts only (the address is a virtual IP): 0 → 1 or 2, or back to 0, on a live cache; the URL stays and it serves throughout","type":"integer","minimum":0,"maximum":2}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:ModifyCacheCluster","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"cache.clusters.delete","summary":"Delete a cache, its machine, volume and password","description":"`cache:DeleteCacheCluster` Delete a cache, its machine, volume and password. Refused (409, naming the apps) while an app is bound to it. Its daily snapshots go with it; manual ones stay. With finalSnapshot=true a snapshot is taken first and kept until you delete it (counted as a manual snapshot); if it fails, nothing is deleted and the cache is available again.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}},{"name":"finalSnapshot","in":"query","required":false,"schema":{"description":"true: take a snapshot first and keep it until you delete it; if it fails, nothing is deleted","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DeleteCacheCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/clusters/{id}/events":{"get":{"operationId":"cache.clusters.events","summary":"The cache’s activity: provisioning steps and what the machine reported","description":"`cache:DescribeCacheClusters` The cache’s activity: provisioning steps and what the machine reported.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/cache/api/clusters/{id}/password/rotate":{"post":{"operationId":"cache.clusters.rotate-password","summary":"Replace the cache’s password with a new Secrets version","description":"`cache:RotateCachePassword` Replace the cache’s password with a new Secrets version. The machine takes the new password within a minute; with redeployApps (default) every bound app is then redeployed, which also needs deploy:DeployApp on each.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"redeployApps":{"default":true,"type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:RotateCachePassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/clusters/{id}/reboot":{"post":{"operationId":"cache.clusters.reboot","summary":"Restart the cache’s machine (data survives on its volume). With replicas: one node, the primary unless nodeId names another — a failover test","description":"`cache:RebootCacheCluster` Restart the cache’s machine (data survives on its volume). With replicas: one node, the primary unless nodeId names another — a failover test.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","maxLength":64}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:RebootCacheCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/clusters/{id}/rotate-storage-key":{"post":{"operationId":"cache.clusters.rotate-storage-key","summary":"Replace the encrypted data volume’s LUKS passphrase with a new key","description":"`cache:RotateCacheStorageKey` Replace the encrypted data volume’s LUKS passphrase with a new key. Answers 202 with each volume’s key version. The node adds the new key, removes the old one and reports within five minutes; Valkey keeps running. The dm-crypt volume key itself is not changed.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:RotateCacheStorageKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/clusters/{id}/snapshots":{"post":{"operationId":"cache.clusters.snapshot","summary":"Take a snapshot now (a replica takes it when there is one)","description":"`cache:CreateCacheSnapshot` Take a snapshot now (a replica takes it when there is one). Answers 202 with the snapshot `pending`; a node takes it at its next report (within a minute) and it is `available` once uploaded. Manual snapshots are kept until deleted, also after the cache is.","tags":["Caches"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:CreateCacheSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/cache/api/node-types":{"get":{"operationId":"cache.clusters.node-types","summary":"The machine types a cache can run on, with price and stock","description":"`cache:DescribeCacheClusters` The machine types a cache can run on, with price and stock.","tags":["Caches"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/cache/api/snapshots":{"get":{"operationId":"cache.snapshots.list","summary":"List snapshots, optionally of one cache","description":"`cache:DescribeCacheSnapshots` List snapshots, optionally of one cache.","tags":["Caches"],"parameters":[{"name":"cacheId","in":"query","required":false,"schema":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheSnapshots","x-ews-mutates":false,"x-ews-sensitive":false}},"/cache/api/snapshots/{snapshotId}":{"get":{"operationId":"cache.snapshots.get","summary":"One snapshot: state, size, key count, SHA-256","description":"`cache:DescribeCacheSnapshots` One snapshot: state, size, key count, SHA-256.","tags":["Caches"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^ecs-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DescribeCacheSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"cache.snapshots.delete","summary":"Delete a snapshot and its stored copy","description":"`cache:DeleteCacheSnapshot` Delete a snapshot and its stored copy.","tags":["Caches"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^ecs-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cache:DeleteCacheSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/cdn/api/distributions":{"get":{"operationId":"cdn.distributions.list","summary":"List distributions with their edge state","description":"`cdn:ListDistributions` List distributions with their edge state.","tags":["CDN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:ListDistributions","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"cdn.distributions.create","summary":"Create a distribution; its platform name <id>.cdn.apps.<root> answers within a minute","description":"`cdn:CreateDistribution` Create a distribution; its platform name <id>.cdn.apps.<root> answers within a minute. origin.type bucket needs the bucket website on; app and lb use the resource’s own name; custom is a public host (never a private or platform address). Aliases must be names in the org’s hosted zones: a CNAME to the platform name is written for each, and they are served once their certificate is issued (aliasCertificate.status active). webAclId attaches a web ACL (needs waf:GetWebAcl on it). edgeRegions: de1 (Falkenstein + Nuremberg); fi1 (Helsinki) needs the org setting for EU outside Germany. Origins see the header X-EWS-CDN-Token: originToken.","tags":["CDN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"comment":{"type":"string","maxLength":256},"origin":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"bucket"},"bucket":{"type":"string","minLength":3,"maxLength":63,"description":"A bucket of the org with its static website on"}},"required":["type","bucket"]},{"type":"object","properties":{"type":{"type":"string","const":"app"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A deployed app of the org"}},"required":["type","appId"]},{"type":"object","properties":{"type":{"type":"string","const":"lb"},"loadBalancerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A load balancer of the org (its own name is used)"}},"required":["type","loadBalancerId"]},{"type":"object","properties":{"type":{"type":"string","const":"custom"},"host":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$","description":"A public host name; never a private or platform address"},"port":{"type":"integer","minimum":1,"maximum":65535},"protocol":{"default":"https","type":"string","enum":["https","http"]},"hostHeader":{"description":"The Host header sent to the origin (default: host)","type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"}},"required":["type","host"]}]},"aliases":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"}},"cache":{"type":"object","properties":{"enabled":{"type":"boolean"},"defaultTtl":{"description":"Seconds, when the origin sends no Cache-Control or Expires (default 86400)","type":"integer","minimum":0,"maximum":31536000},"minTtl":{"type":"integer","minimum":0,"maximum":31536000},"maxTtl":{"type":"integer","minimum":0,"maximum":31536000},"queryString":{"description":"What of the query string is part of the cache key","type":"string","enum":["all","none","allowlist"]},"queryKeys":{"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"forwardCookies":{"description":"Send cookies to the origin; then a request with a cookie is never cached","type":"boolean"},"staleWhileRevalidate":{"description":"Seconds an expired object is still answered while the edge refreshes it in the background, when the origin's Cache-Control has no stale-while-revalidate (default 0)","type":"integer","minimum":0,"maximum":604800},"staleIfError":{"description":"Seconds an expired object is answered instead of an origin failure (no connection, timeout, 500/502/503/504), when the origin's Cache-Control has no stale-if-error (default 86400)","type":"integer","minimum":0,"maximum":604800}},"additionalProperties":false},"webAclId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"edgeRegions":{"minItems":1,"type":"array","items":{"type":"string","enum":["de1","fi1"]},"description":"de1 (Falkenstein + Nuremberg) always; fi1 (Helsinki) for orgs that allow EU outside Germany"},"enabled":{"type":"boolean"},"redirectHttps":{"description":"Answer http:// requests with a 308 redirect to https:// (default false). Custom names redirect once their certificate is active.","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","origin"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:CreateDistribution","x-ews-mutates":true,"x-ews-sensitive":false}},"/cdn/api/distributions/{id}":{"get":{"operationId":"cdn.distributions.get","summary":"Describe a distribution: origin, names, cache settings, web ACL, every edge node serving it","description":"`cdn:GetDistribution` Describe a distribution: origin, names, cache settings, web ACL, every edge node serving it.","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:GetDistribution","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"cdn.distributions.update","summary":"Change a distribution (origin, aliases, cache, web ACL, regions); rotateOriginToken: true for a new token","description":"`cdn:UpdateDistribution` Change a distribution (origin, aliases, cache, web ACL, regions); rotateOriginToken: true for a new token. webAclId: null detaches the web ACL. A change reaches the edge nodes within a few seconds.","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","maxLength":256},"origin":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"bucket"},"bucket":{"type":"string","minLength":3,"maxLength":63,"description":"A bucket of the org with its static website on"}},"required":["type","bucket"]},{"type":"object","properties":{"type":{"type":"string","const":"app"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A deployed app of the org"}},"required":["type","appId"]},{"type":"object","properties":{"type":{"type":"string","const":"lb"},"loadBalancerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A load balancer of the org (its own name is used)"}},"required":["type","loadBalancerId"]},{"type":"object","properties":{"type":{"type":"string","const":"custom"},"host":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$","description":"A public host name; never a private or platform address"},"port":{"type":"integer","minimum":1,"maximum":65535},"protocol":{"default":"https","type":"string","enum":["https","http"]},"hostHeader":{"description":"The Host header sent to the origin (default: host)","type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"}},"required":["type","host"]}]},"aliases":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"}},"cache":{"type":"object","properties":{"enabled":{"type":"boolean"},"defaultTtl":{"description":"Seconds, when the origin sends no Cache-Control or Expires (default 86400)","type":"integer","minimum":0,"maximum":31536000},"minTtl":{"type":"integer","minimum":0,"maximum":31536000},"maxTtl":{"type":"integer","minimum":0,"maximum":31536000},"queryString":{"description":"What of the query string is part of the cache key","type":"string","enum":["all","none","allowlist"]},"queryKeys":{"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"forwardCookies":{"description":"Send cookies to the origin; then a request with a cookie is never cached","type":"boolean"},"staleWhileRevalidate":{"description":"Seconds an expired object is still answered while the edge refreshes it in the background, when the origin's Cache-Control has no stale-while-revalidate (default 0)","type":"integer","minimum":0,"maximum":604800},"staleIfError":{"description":"Seconds an expired object is answered instead of an origin failure (no connection, timeout, 500/502/503/504), when the origin's Cache-Control has no stale-if-error (default 86400)","type":"integer","minimum":0,"maximum":604800}},"additionalProperties":false},"webAclId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"edgeRegions":{"minItems":1,"type":"array","items":{"type":"string","enum":["de1","fi1"]},"description":"de1 (Falkenstein + Nuremberg) always; fi1 (Helsinki) for orgs that allow EU outside Germany"},"enabled":{"type":"boolean"},"redirectHttps":{"description":"Answer http:// requests with a 308 redirect to https:// (default false). Custom names redirect once their certificate is active.","type":"boolean"},"rotateOriginToken":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:UpdateDistribution","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"cdn.distributions.delete","summary":"Delete a distribution; its names stop answering","description":"`cdn:DeleteDistribution` Delete a distribution; its names stop answering.","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:DeleteDistribution","x-ews-mutates":true,"x-ews-sensitive":false}},"/cdn/api/distributions/{id}/invalidations":{"post":{"operationId":"cdn.invalidations.create","summary":"Purge by path (/a), path prefix (/img/*), everything (/*) or tag (Cache-Tag / Surrogate-Key)","description":"`cdn:CreateInvalidation` Purge by path (/a), path prefix (/img/*), everything (/*) or tag (Cache-Tag / Surrogate-Key). Applied by each node within a few seconds; status turns completed once every live edge node has applied it (about 10–70 s, the nodes report every 10 s and the control plane checks every minute).","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paths":{"description":"Exact paths, or a prefix ending in * (`/img/*`); `/*` purges everything","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":1024,"format":"starts_with","pattern":"^\\/.*"}},"tags":{"description":"Tags the origin set in Cache-Tag or Surrogate-Key","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:CreateInvalidation","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"cdn.invalidations.list","summary":"List a distribution’s purges and the edge nodes that applied each","description":"`cdn:ListInvalidations` List a distribution’s purges and the edge nodes that applied each.","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:ListInvalidations","x-ews-mutates":false,"x-ews-sensitive":false}},"/cdn/api/distributions/{id}/stats":{"get":{"operationId":"cdn.distributions.stats","summary":"Cache hit ratio, bytes and WAF counts per minute, and live counters per edge node","description":"`cdn:GetDistributionStats` Cache hit ratio, bytes and WAF counts per minute, and live counters per edge node.","tags":["CDN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hours","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":168}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:GetDistributionStats","x-ews-mutates":false,"x-ews-sensitive":false}},"/cdn/api/edge":{"get":{"operationId":"cdn.edge.list","summary":"List the edge nodes with their reported DDoS settings (SYN cookies, nftables caps)","description":"`cdn:ListDistributions` List the edge nodes with their reported DDoS settings (SYN cookies, nftables caps).","tags":["CDN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cdn:ListDistributions","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/approvals/{approvalId}/review":{"post":{"operationId":"ci.environments.review","summary":"Approve or reject a job waiting at an environment","description":"`ci:ReviewDeployments` Approve or reject a job waiting at an environment. Needs the IAM action AND a place on the environment’s reviewer list; with preventSelfReview, not the person who started the run. 409 when it was already decided.","tags":["CI"],"parameters":[{"name":"approvalId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Approval id, from `ci environments approvals`"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","reject"]},"comment":{"type":"string","maxLength":2000}},"required":["decision"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ReviewDeployments","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/artifacts/{artifactId}/download":{"get":{"operationId":"ci.artifacts.download","summary":"Download an artifact","description":"`ci:DownloadArtifact` Download an artifact. Redirects (302) to a presigned storage URL valid for five minutes; over MCP the tool answers `{ url }` instead of the bytes. 410 once the artifact has expired.","tags":["CI"],"parameters":[{"name":"artifactId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Artifact id, from `ci artifacts list`"}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DownloadArtifact","x-ews-mutates":false,"x-ews-sensitive":true}},"/ci/api/jobs/{jobId}/logs":{"get":{"operationId":"ci.jobs.logs","summary":"Read one page of a job’s log","description":"`ci:GetRunLogs` Read one page of a job’s log. Answers `{ lines, nextCursor, hasMore }`. Pass nextCursor back as `cursor` for the next page; while the job runs, an empty page means no new lines yet.","tags":["CI"],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Job id, from `ci runs get`"}},{"name":"after","in":"query","required":false,"schema":{"description":"Older clients: the sequence number to read after. Prefer cursor","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"cursor","in":"query","required":false,"schema":{"description":"nextCursor from the previous page","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"description":"Lines per page","type":"integer","minimum":1,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:GetRunLogs","x-ews-mutates":false,"x-ews-sensitive":true}},"/ci/api/repositories/{repoId}/approvals":{"get":{"operationId":"ci.environments.approvals","summary":"Jobs waiting at an environment for a reviewer (all=true: decided ones too)","description":"`ci:ListEnvironments` Jobs waiting at an environment for a reviewer (all=true: decided ones too).","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"all","in":"query","required":false,"schema":{"description":"Also decided ones, newest first","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListEnvironments","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/environments":{"get":{"operationId":"ci.environments.list","summary":"List a repository’s environments and their protection rules","description":"`ci:ListEnvironments` List a repository’s environments and their protection rules. A workflow that names an environment (`environment: production`) creates it without rules, as on GitHub (`createdByWorkflow`).","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListEnvironments","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/environments/{name}":{"put":{"operationId":"ci.environments.put","summary":"Create an environment or change its protection rules","description":"`ci:PutEnvironment` Create an environment or change its protection rules. Fields left out keep their value. `reviewers` are IAM user ids of this organization (up to six); one of them must approve each job. `deploymentBranchPolicy`: all, protected (branches with a protection rule) or custom (`deploymentPatterns`). Environment secrets are the org secrets environment with the same slug.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Environment name, e.g. production"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"waitTimerMinutes":{"type":"integer","minimum":0,"maximum":43200},"reviewers":{"maxItems":6,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"preventSelfReview":{"type":"boolean"},"deploymentBranchPolicy":{"type":"string","enum":["all","protected","custom"]},"deploymentPatterns":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["branch","tag"]},"pattern":{"type":"string","minLength":1,"maxLength":255}},"required":["type","pattern"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutEnvironment","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.environments.delete","summary":"Delete an environment with its rules and variables","description":"`ci:DeleteEnvironment` Delete an environment with its rules and variables.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Environment name, e.g. production"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DeleteEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/environments/{name}/variables":{"get":{"operationId":"ci.variables.list-environment","summary":"List an environment’s variables","description":"`ci:ListVariables` List an environment’s variables.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Environment name, e.g. production"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListVariables","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/environments/{name}/variables/{variable}":{"put":{"operationId":"ci.variables.put-environment","summary":"Create or change an environment variable","description":"`ci:PutVariable` Create or change an environment variable.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Environment name, e.g. production"}},{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","maxLength":49152,"description":"Plain text, never secret; up to 48 KiB"}},"required":["value"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutVariable","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.variables.delete-environment","summary":"Delete an environment variable","description":"`ci:DeleteVariable` Delete an environment variable.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Environment name, e.g. production"}},{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DeleteVariable","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/runs":{"get":{"operationId":"ci.runs.list","summary":"List a repository’s most recent runs, newest first","description":"`ci:ListRuns` List a repository’s most recent runs, newest first. At most the 50 newest runs; there is no paging or filter yet.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListRuns","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/variables":{"get":{"operationId":"ci.variables.list","summary":"List a repository’s variables","description":"`ci:ListVariables` List a repository’s variables. A repository variable wins over an organization one of the same name; an environment variable wins over both, in jobs of that environment.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListVariables","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/variables/{variable}":{"put":{"operationId":"ci.variables.put","summary":"Create or change a repository variable","description":"`ci:PutVariable` Create or change a repository variable.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","maxLength":49152,"description":"Plain text, never secret; up to 48 KiB"}},"required":["value"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutVariable","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.variables.delete","summary":"Delete a repository variable","description":"`ci:DeleteVariable` Delete a repository variable.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}},{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DeleteVariable","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/repositories/{repoId}/workflows/dispatch":{"post":{"operationId":"ci.dispatch.start","summary":"Run one workflow file now, at a branch or tag, with inputs","description":"`ci:StartWorkflow` Run one workflow file now, at a branch or tag, with inputs. A `.github/workflows/` file needs `on: workflow_dispatch`; an `.ews/workflows/` file needs `on.manual`. The file is read at the tip of `ref` (default branch when absent); declared input defaults fill what is not passed. 201 with `{ runId, workflowName, path }`; 409 when the file does not accept a manual start.","tags":["CI"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id (uuid)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":500,"description":"Workflow file, e.g. .github/workflows/ci.yml"},"ref":{"description":"Branch or tag; the default branch when absent","type":"string","minLength":1,"maxLength":250},"inputs":{"description":"workflow_dispatch inputs, name → value","type":"object","propertyNames":{"type":"string","maxLength":100},"additionalProperties":{"type":"string","maxLength":10000}}},"required":["path"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:StartWorkflow","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runner-groups":{"get":{"operationId":"ci.runner-groups.list","summary":"List the runner groups of this organization","description":"`ci:DescribeRunners` List the runner groups of this organization. A runner without a group is in Default, which takes any run its labels match.","tags":["CI"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DescribeRunners","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ci.runner-groups.create","summary":"Create a runner group","description":"`ci:ManageRunners` Create a runner group. A run reaches a runner of the group only when its repository, its ref and its event are all allowed. A merge queue build is judged by the branch it lands on.","tags":["CI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"repositoryIds":{"description":"Repositories the group serves; null or absent: every repository","anyOf":[{"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"refs":{"description":"Ref globs it serves (`main`, `release/*`, `refs/tags/v*`); empty: any ref","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"protectedRefsOnly":{"description":"Only branches covered by a branch protection rule; for runners that hold deploy credentials","type":"boolean"},"allowPullRequests":{"description":"Whether pull-request runs reach it (default true)","type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runner-groups/{id}":{"patch":{"operationId":"ci.runner-groups.update","summary":"Change a runner group","description":"`ci:ManageRunners` Change a runner group.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"repositoryIds":{"description":"Repositories the group serves; null or absent: every repository","anyOf":[{"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"refs":{"description":"Ref globs it serves (`main`, `release/*`, `refs/tags/v*`); empty: any ref","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"protectedRefsOnly":{"description":"Only branches covered by a branch protection rule; for runners that hold deploy credentials","type":"boolean"},"allowPullRequests":{"description":"Whether pull-request runs reach it (default true)","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.runner-groups.delete","summary":"Delete a runner group","description":"`ci:ManageRunners` Delete a runner group. 409 while runners belong to it: they would otherwise fall back to Default.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runner-pools":{"get":{"operationId":"ci.runner-pools.list","summary":"List the runner pools of this organization","description":"`ci:DescribeRunnerPools` List the runner pools of this organization.","tags":["CI"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DescribeRunnerPools","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ci.runner-pools.create","summary":"Create a runner pool","description":"`ci:CreateRunnerPool` Create a runner pool. Creates a launch template and an auto scaling group named runner-pool-<name> in your organization (also needs autoscaling:CreateLaunchTemplate, autoscaling:CreateAutoScalingGroup and ec2:RunInstances). A job whose runs-on labels are all among the pool’s goes to it, with or without self-hosted in the file: give a pool ubuntu-latest and ubuntu-24.04 to move hosted jobs onto per-job machines. Idle machines stay until shortly before their paid hour ends.","tags":["CI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,39}$","description":"Name of the pool; its group and template are named runner-pool-<name>"},"labels":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,49}$"},"description":"Jobs whose runs-on labels are all among these go here, e.g. ubuntu-latest, ubuntu-24.04 (hosted jobs) or hetzner-16"},"size":{"type":"string","enum":["s-2","s-4","s-8","s-16","m-4","d-2","d-8","a-2","a-4","a-8","a-16"],"description":"Machine size: s-2 (2 vCPU / 4 GiB), s-4 (4 / 8), s-8 (8 / 16), s-16 (16 / 32), d-2, d-8 (dedicated), a-2, a-4, a-8, a-16 (ARM, for ubuntu-24.04-arm jobs); the smallest machine of your provider that fits"},"minSize":{"description":"Machines always on (the base)","type":"integer","minimum":0,"maximum":200},"maxSize":{"type":"integer","minimum":1,"maximum":200,"description":"Most machines at once"},"spare":{"description":"Idle machines kept above demand","type":"integer","minimum":0,"maximum":50},"cleanMachinePerJob":{"description":"Destroy every machine after its job instead of reusing it within its paid hour","type":"boolean"},"shareTrustedMachines":{"description":"Let trusted jobs (default branch, tags, dispatch, schedules) of every repository share machines; pull request jobs never do","type":"boolean"},"prebuiltImage":{"description":"Start machines from the organization's pre-built runner image once it is built (first job about a minute sooner); default true; false: stock Ubuntu, installed at every boot","type":"boolean"},"runnerGroupId":{"description":"A runner group whose repository and ref rules decide which runs reach the pool","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["name","labels","size","maxSize"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:CreateRunnerPool","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runner-pools/{id}":{"get":{"operationId":"ci.runner-pools.get","summary":"A pool with its machines, waiting and running jobs, and the last scaling decision","description":"`ci:DescribeRunnerPools` A pool with its machines, waiting and running jobs, and the last scaling decision.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DescribeRunnerPools","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ci.runner-pools.update","summary":"Change a pool’s labels, sizes, spare machines or machine reuse","description":"`ci:UpdateRunnerPool` Change a pool’s labels, sizes, spare machines or machine reuse.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,49}$"},"description":"Jobs whose runs-on labels are all among these go here, e.g. ubuntu-latest, ubuntu-24.04 (hosted jobs) or hetzner-16"},"minSize":{"description":"Machines always on (the base)","type":"integer","minimum":0,"maximum":200},"maxSize":{"type":"integer","minimum":1,"maximum":200,"description":"Most machines at once"},"spare":{"description":"Idle machines kept above demand","type":"integer","minimum":0,"maximum":50},"cleanMachinePerJob":{"description":"Destroy every machine after its job instead of reusing it within its paid hour","type":"boolean"},"shareTrustedMachines":{"description":"Let trusted jobs (default branch, tags, dispatch, schedules) of every repository share machines; pull request jobs never do","type":"boolean"},"prebuiltImage":{"description":"Start machines from the organization's pre-built runner image once it is built (first job about a minute sooner); default true; false: stock Ubuntu, installed at every boot","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:UpdateRunnerPool","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.runner-pools.delete","summary":"Delete a pool: its machines drain (a running job finishes) and go","description":"`ci:DeleteRunnerPool` Delete a pool: its machines drain (a running job finishes) and go.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DeleteRunnerPool","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runners":{"get":{"operationId":"ci.runners.list","summary":"List the self-hosted runners registered to this organization","description":"`ci:DescribeRunners` List the self-hosted runners registered to this organization. Credential hashes are never returned. `status` is online, offline or disabled; `lastSeenAt` is the last heartbeat or claim.","tags":["CI"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DescribeRunners","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/runners/{id}":{"patch":{"operationId":"ci.runners.set-group","summary":"Move a runner into a runner group, or back to Default","description":"`ci:ManageRunners` Move a runner into a runner group, or back to Default.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The group; null for Default"}},"required":["groupId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.runners.disable","summary":"Disable a runner and revoke its credential","description":"`ci:ManageRunners` Disable a runner and revoke its credential. The row is kept so past runs still name the machine that ran them; the credential is overwritten, so the machine stops working immediately.","tags":["CI"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runners/registration-tokens":{"post":{"operationId":"ci.runners.create-registration-token","summary":"Issue a one-time token a machine registers itself with","description":"`ci:ManageRunners` Issue a one-time token a machine registers itself with. The token is returned once and stored hashed. It expires after 15 minutes and can be redeemed by exactly one machine. `configCommand` registers GitHub’s own runner (`./config.sh --url https://git.{root}/{org}[/{repo}] --token …`), which then runs GitHub-syntax jobs with `runs-on: self-hosted` (plus any labels it carries); `installCommand` installs the Deutsche Cloud agent on a Mac. A runner that will hold deploy credentials belongs in a group with `protectedRefsOnly`.","tags":["CI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"repositoryId":{"description":"Limit the token, and the runner it registers, to this repository (authorized on the repository); org-wide when absent","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"groupId":{"description":"The runner group the machine joins; the Default group when absent","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"labels":{"description":"Fix the runner’s custom labels; what the machine declares is then ignored (platform labels such as self-hosted, linux, x64 are kept)","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ManageRunners","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runs/{runId}":{"get":{"operationId":"ci.runs.get","summary":"One run with its jobs and their steps, each with status and timing","description":"`ci:GetRun` One run with its jobs and their steps, each with status and timing. Answers `{ run, jobs, steps }`. A failed step names its job; read that job’s log with `dcloud ci jobs logs`.","tags":["CI"],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id, from `ci runs list`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:GetRun","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/runs/{runId}/artifacts":{"get":{"operationId":"ci.artifacts.list","summary":"List a run’s artifacts with size and expiry","description":"`ci:ListArtifacts` List a run’s artifacts with size and expiry.","tags":["CI"],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id, from `ci runs list`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListArtifacts","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/runs/{runId}/cancel":{"post":{"operationId":"ci.runs.cancel","summary":"Cancel a run that is queued or in progress","description":"`ci:CancelRun` Cancel a run that is queued or in progress. Its machines are torn down within moments; a runner that has not started it never will. 409 when the run has already finished.","tags":["CI"],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id, from `ci runs list`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:CancelRun","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/runs/{runId}/rerun":{"post":{"operationId":"ci.runs.rerun","summary":"Start a new run of the same workflow at the same commit","description":"`ci:RerunWorkflow` Start a new run of the same workflow at the same commit. Planned from the workflow source the original run used, not the current file, so it reproduces what ran. Answers the new run.","tags":["CI"],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id, from `ci runs list`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:RerunWorkflow","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/variables":{"get":{"operationId":"ci.variables.list-org","summary":"List the organization’s variables (every repository sees them)","description":"`ci:ListVariables` List the organization’s variables (every repository sees them).","tags":["CI"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListVariables","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/variables/{variable}":{"put":{"operationId":"ci.variables.put-org","summary":"Create or change an organization variable","description":"`ci:PutVariable` Create or change an organization variable.","tags":["CI"],"parameters":[{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","maxLength":49152,"description":"Plain text, never secret; up to 48 KiB"}},"required":["value"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutVariable","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ci.variables.delete-org","summary":"Delete an organization variable","description":"`ci:DeleteVariable` Delete an organization variable.","tags":["CI"],"parameters":[{"name":"variable","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$","description":"Variable name: letters, digits and _, stored upper-case"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:DeleteVariable","x-ews-mutates":true,"x-ews-sensitive":false}},"/ci/api/workflows/convert":{"post":{"operationId":"ci.workflows.convert","summary":"Translate a GitHub Actions or GitLab CI file into a Deutsche Cloud workflow","description":"`ci:ListRuns` Translate a GitHub Actions or GitLab CI file into a Deutsche Cloud workflow. Answers `{ yaml, valid, issues, notes }`; `notes` lists what had no Deutsche Cloud equivalent and was left out. The result is validated by the real parser, with one repair round, and returned rather than committed. 503 when the installation has no AI provider configured. The prompt it uses is public at /docs/workflows/prompt.md.","tags":["CI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":65536},"from":{"type":"string","enum":["github","gitlab","other"]},"filename":{"type":"string","minLength":1,"maxLength":200}},"required":["source","from"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListRuns","x-ews-mutates":false,"x-ews-sensitive":false}},"/ci/api/workflows/validate":{"post":{"operationId":"ci.workflows.validate","summary":"Check a workflow file against the parser without pushing it","description":"`ci:ListRuns` Check a workflow file against the parser without pushing it. The same parser a push runs. Answers `{ valid, issues }`; each issue names the key and, where the source allowed it, the line.","tags":["CI"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":65536},"path":{"description":"Where the file will live; under .github/workflows/ it is checked as GitHub Actions","type":"string","minLength":1,"maxLength":500}},"required":["source"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListRuns","x-ews-mutates":false,"x-ews-sensitive":false}},"/cloudshell/api/environment":{"get":{"operationId":"cloudshell.environment.get","summary":"Your environment: running or not, the home directory, limits, the cost","description":"`cloudshell:DescribeEnvironment` Your environment: running or not, the home directory, limits, the cost.","tags":["Cloud shell"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:DescribeEnvironment","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"cloudshell.environment.delete","summary":"Delete your environment: the shell ends and the saved home is deleted","description":"`cloudshell:DeleteEnvironment` Delete your environment: the shell ends and the saved home is deleted.","tags":["Cloud shell"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:DeleteEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/cloudshell/api/environments":{"get":{"operationId":"cloudshell.environments.list","summary":"Every environment of the organization: whose, how big, when used","description":"`cloudshell:DescribeEnvironment` Every environment of the organization: whose, how big, when used.","tags":["Cloud shell"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:DescribeEnvironment","x-ews-mutates":false,"x-ews-sensitive":false}},"/cloudshell/api/environments/{iamUserId}":{"delete":{"operationId":"cloudshell.environments.delete","summary":"Delete someone’s environment (ends their shell, deletes their home)","description":"`cloudshell:DeleteEnvironment` Delete someone’s environment (ends their shell, deletes their home).","tags":["Cloud shell"],"parameters":[{"name":"iamUserId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:DeleteEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/cloudshell/api/session":{"post":{"operationId":"cloudshell.environment.start-session","summary":"Open your shell (console sessions only): its terminal address and token","description":"`cloudshell:StartSession` Open your shell (console sessions only): its terminal address and token. 202 while it starts (the organization’s first shell waits about 90 s for its sandbox host): call again until 201. Refused with an access key: the shell’s credential is minted from your console session and is deleted when you log out.","tags":["Cloud shell"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terminal":{"description":"false: only renew the credential in a shell that is already open","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:StartSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/cloudshell/api/session/end":{"post":{"operationId":"cloudshell.environment.end-session","summary":"End your shell now; the home directory is saved first","description":"`cloudshell:StartSession` End your shell now; the home directory is saved first. Ending your own shell needs no permission.","tags":["Cloud shell"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"cloudshell:StartSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps":{"get":{"operationId":"deploy.apps.list","summary":"List apps","description":"`deploy:DescribeApp` List apps.","tags":["Apps"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"App id"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the app belongs to"},"name":{"type":"string","description":"Display name"},"slug":{"type":"string","description":"Short name used in the default hostname, unique in the organization"},"environmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets only"},"gitRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Git repository the app builds from; null for an app that runs an image"},"branch":{"description":"Branch the app deploys from; null means the repository’s default branch","type":["string","null"]},"deployOnPush":{"type":"boolean","description":"Whether each commit pushed to the branch is deployed"},"rootDir":{"type":"string","description":"Directory in the repository the app is built from"},"imageRef":{"description":"Container image the app runs, for builder image; null otherwise","type":["string","null"]},"composeSource":{"anyOf":[{"type":"string","enum":["inline","git"]},{"type":"null"}],"description":"Compose apps: where the compose file comes from; null for other builders"},"composePath":{"description":"Compose apps with composeSource git: path of the compose file in the repository","type":["string","null"]},"composeService":{"description":"Compose apps: the service published on the app’s domains","type":["string","null"]},"composePort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Compose apps: the container port of composeService that receives traffic"},"hosting":{"type":"string","enum":["machine","pooled"],"description":"machine: its own machines; pooled: a Next.js app on shared hosts"},"memoryMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: memory reserved for the app’s server while it runs, in MB"},"idleSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: seconds without a request after which the server is stopped"},"poolHostId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Pooled hosting: the shared host the app is placed on; null until placed"},"dataSavedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Pooled hosting: when the app’s data directory was last saved; null if never"},"dataBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the last saved data directory, in bytes"},"builder":{"type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose","nextjs"],"description":"How the app is built; nextjs for pooled hosting"},"buildCommand":{"description":"Build command replacing the detected one; null: the detected one","type":["string","null"]},"startCommand":{"description":"Start command replacing the detected one; null: the detected one","type":["string","null"]},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port the app listens on in its container"},"releaseCommand":{"description":"Command run once per deployment before traffic moves; null: none","type":["string","null"]},"releaseService":{"description":"Compose apps: service the release command runs in; null: the published service","type":["string","null"]},"releaseTimeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds the release command may run"},"healthCheck":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false},{"type":"null"}],"description":"HTTP check a new container must pass; null means GET / below 500"},"composeHealthChecks":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false}},{"type":"null"}],"description":"Compose apps: health checks of other services, by service name; null: none"},"instanceType":{"type":"string","description":"Machine size of each machine (pooled for pooled hosting), e.g. performance-2"},"replicas":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of machines"},"locations":{"type":"array","items":{"type":"string"},"description":"Locations the machines are spread over in order; empty: the region’s own location"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The app’s load balancer, when it has more than one machine or location; else null"},"loadBalancerIpv4":{"description":"Public address of the app’s load balancer; null without one","type":["string","null"]},"ecrRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Repository of the organization’s registry the app pulls from; null: none"},"serviceAccountIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The app’s own identity its machines sign in with; null until provisioned"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Counter raised with every new desired deployment; machines roll when it changes"},"activeDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The deployment live now; null before the first one"},"status":{"type":"string","enum":["created","provisioning","active","suspended","error","deleting"],"description":"created, provisioning, active, suspended, error or deleting"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"tlsReport":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When a machine reported"},"entries":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"ok":{"type":"boolean","description":"Whether a certificate is served for it"},"error":{"description":"Why not, as the TLS handshake said it","type":"string"}},"required":["host","ok"],"additionalProperties":false},"description":"One entry per hostname the machine serves"}},"required":["at","entries"],"additionalProperties":false},{"type":"null"}],"description":"Certificate state a machine last reported, hostname by hostname; null: none yet"},"envChangedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the environment or a binding last changed; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was last changed"},"hasComposeFile":{"type":"boolean","description":"Whether the app has an uploaded compose file"},"defaultUrl":{"type":"string","description":"The app’s default hostname"}},"required":["id","orgId","name","slug","environmentId","gitRepositoryId","branch","deployOnPush","rootDir","imageRef","composeSource","composePath","composeService","composePort","hosting","memoryMb","idleSeconds","poolHostId","dataSavedAt","dataBytes","builder","buildCommand","startCommand","port","releaseCommand","releaseService","releaseTimeoutSec","healthCheck","composeHealthChecks","instanceType","replicas","locations","hetznerLoadBalancerId","loadBalancerIpv4","ecrRepositoryId","serviceAccountIamUserId","generation","activeDeploymentId","status","reconcileError","tlsReport","envChangedAt","createdAt","updatedAt","hasComposeFile","defaultUrl"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"deploy.apps.create","summary":"Create an app","description":"`deploy:CreateApp` Create an app. builder \"image\" needs imageRef; \"compose\" needs composeSource, composeService and composePort.","tags":["Apps"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"Display name of the app"},"slug":{"description":"Short name used in the app’s default hostname; must be unique in the organization; derived from name when omitted","type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"hosting":{"description":"machine (default): the app runs on its own machines; pooled: a Next.js app on shared hosts that scales to zero, deployed from bundles your CI uploads","type":"string","enum":["machine","pooled"]},"memoryMb":{"description":"Pooled hosting: memory reserved for the app’s server while it runs, in MB; default 768","type":"integer","minimum":256,"maximum":2048},"idleSeconds":{"description":"Pooled hosting: seconds without a request after which the app’s server is stopped; default 300","type":"integer","minimum":60,"maximum":3600},"database":{"description":"Pooled hosting only: postgres gives the app a Postgres database on its pool host (needs deploy:ManageHostDatabase); none (default) gives it none. An app on its own machines is refused with 400 and binds a managed Postgres instead","type":"string","enum":["none","postgres"]},"gitRepositoryId":{"description":"Git repository the app builds from; required for every builder except image and compose. The app starts with that repository’s tags","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"branch":{"description":"Branch the app deploys from; omitted, the repository’s default branch (main for pooled hosting)","type":"string","minLength":1,"maxLength":255},"deployOnPush":{"description":"Deploy each commit pushed to the branch, as the person who pushed it; default true when gitRepositoryId is set (always false for pooled hosting)","type":"boolean"},"rootDir":{"description":"Directory in the repository the app is built from; default the repository root (.)","type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9._/-]+$"},"builder":{"description":"How the app is built: railpack (default) detects the stack, dockerfile uses the repository’s Dockerfile, image runs imageRef, compose runs a compose file","type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose"]},"buildCommand":{"description":"Replaces the build command the builder would detect","type":"string","maxLength":1024},"startCommand":{"description":"Replaces the command the builder would start the app with","type":"string","maxLength":1024},"imageRef":{"description":"Container image the app runs (host/repository:tag or @sha256 digest); required when builder is image. A short Docker Hub name is stored with docker.io/ in front","type":"string","minLength":1,"maxLength":512,"pattern":"^[a-z0-9]([a-z0-9._-]*[a-z0-9])?(:[0-9]+)?(\\/[a-z0-9]([a-z0-9._-]*[a-z0-9])?)*(:[A-Za-z0-9._-]+|@sha256:[a-f0-9]{64})?$"},"ecrRepositoryId":{"description":"Repository of this organization’s registry the image comes from, so the machines get a pull credential for it; for an inline compose file it is found from the file when omitted","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"composeSource":{"description":"Compose apps: inline takes the file text from composeFile, git reads composePath from the connected repository","type":"string","enum":["inline","git"]},"composeFile":{"description":"Compose apps with composeSource inline: the compose file text, checked when saved","type":"string","maxLength":131072},"composePath":{"description":"Compose apps with composeSource git: path of the compose file in the repository","type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9._/-]+$"},"composeService":{"description":"Compose apps: the service published on the app’s domains; required","type":"string","minLength":1,"maxLength":63},"composePort":{"description":"Compose apps: the container port of composeService that receives traffic; required","type":"integer","minimum":1,"maximum":65535},"port":{"description":"Port the app listens on in its container; default 3000","type":"integer","minimum":1,"maximum":65535},"instanceType":{"description":"Machine size of each machine, an instance type, e.g. performance-2 (the provider’s own names are still accepted, deprecated); default the region’s default size","type":"string","minLength":1,"maxLength":32},"replicas":{"description":"Number of machines; default 1. More than one puts a load balancer in front","type":"integer","minimum":1,"maximum":10},"releaseCommand":{"description":"Command run once per deployment with /bin/sh -c in the new image, before traffic moves to it (e.g. database migrations); null or omitted runs none","anyOf":[{"type":"string","minLength":1,"maxLength":4096},{"type":"null"}]},"releaseService":{"description":"Compose apps: the service whose image and environment run the release command; omitted or null, the published service","anyOf":[{"type":"string","minLength":1,"maxLength":63},{"type":"null"}]},"releaseTimeoutSec":{"description":"Seconds the release command may run before the deployment fails; a new app gets 600","type":"integer","minimum":10,"maximum":3600},"healthCheck":{"description":"The HTTP check a new container must pass before it gets traffic; null or omitted means GET / on the app port, any status below 500","anyOf":[{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512,"pattern":"^\\/[A-Za-z0-9._~!$&'()*+,;=:@%/?-]*$"},"port":{"type":"integer","minimum":1,"maximum":65535},"expectedStatus":{"type":"integer","minimum":100,"maximum":599},"timeoutSec":{"type":"integer","minimum":5,"maximum":1800}},"required":["path"]},{"type":"null"}]},"composeHealthChecks":{"description":"Compose apps: health checks for services other than the published one, keyed by service name","anyOf":[{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512,"pattern":"^\\/[A-Za-z0-9._~!$&'()*+,;=:@%/?-]*$"},"port":{"type":"integer","minimum":1,"maximum":65535},"expectedStatus":{"type":"integer","minimum":100,"maximum":599},"timeoutSec":{"type":"integer","minimum":5,"maximum":1800}},"required":["path"]}},{"type":"null"}]},"tags":{"description":"Tags for the app, added to those inherited from the repository","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"App id"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the app belongs to"},"name":{"type":"string","description":"Display name"},"slug":{"type":"string","description":"Short name used in the default hostname, unique in the organization"},"environmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets only"},"gitRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Git repository the app builds from; null for an app that runs an image"},"branch":{"description":"Branch the app deploys from; null means the repository’s default branch","type":["string","null"]},"deployOnPush":{"type":"boolean","description":"Whether each commit pushed to the branch is deployed"},"rootDir":{"type":"string","description":"Directory in the repository the app is built from"},"imageRef":{"description":"Container image the app runs, for builder image; null otherwise","type":["string","null"]},"composeSource":{"anyOf":[{"type":"string","enum":["inline","git"]},{"type":"null"}],"description":"Compose apps: where the compose file comes from; null for other builders"},"composePath":{"description":"Compose apps with composeSource git: path of the compose file in the repository","type":["string","null"]},"composeService":{"description":"Compose apps: the service published on the app’s domains","type":["string","null"]},"composePort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Compose apps: the container port of composeService that receives traffic"},"hosting":{"type":"string","enum":["machine","pooled"],"description":"machine: its own machines; pooled: a Next.js app on shared hosts"},"memoryMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: memory reserved for the app’s server while it runs, in MB"},"idleSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: seconds without a request after which the server is stopped"},"poolHostId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Pooled hosting: the shared host the app is placed on; null until placed"},"dataSavedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Pooled hosting: when the app’s data directory was last saved; null if never"},"dataBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the last saved data directory, in bytes"},"builder":{"type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose","nextjs"],"description":"How the app is built; nextjs for pooled hosting"},"buildCommand":{"description":"Build command replacing the detected one; null: the detected one","type":["string","null"]},"startCommand":{"description":"Start command replacing the detected one; null: the detected one","type":["string","null"]},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port the app listens on in its container"},"releaseCommand":{"description":"Command run once per deployment before traffic moves; null: none","type":["string","null"]},"releaseService":{"description":"Compose apps: service the release command runs in; null: the published service","type":["string","null"]},"releaseTimeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds the release command may run"},"healthCheck":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false},{"type":"null"}],"description":"HTTP check a new container must pass; null means GET / below 500"},"composeHealthChecks":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false}},{"type":"null"}],"description":"Compose apps: health checks of other services, by service name; null: none"},"instanceType":{"type":"string","description":"Machine size of each machine (pooled for pooled hosting), e.g. performance-2"},"replicas":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of machines"},"locations":{"type":"array","items":{"type":"string"},"description":"Locations the machines are spread over in order; empty: the region’s own location"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The app’s load balancer, when it has more than one machine or location; else null"},"loadBalancerIpv4":{"description":"Public address of the app’s load balancer; null without one","type":["string","null"]},"ecrRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Repository of the organization’s registry the app pulls from; null: none"},"serviceAccountIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The app’s own identity its machines sign in with; null until provisioned"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Counter raised with every new desired deployment; machines roll when it changes"},"activeDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The deployment live now; null before the first one"},"status":{"type":"string","enum":["created","provisioning","active","suspended","error","deleting"],"description":"created, provisioning, active, suspended, error or deleting"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"tlsReport":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When a machine reported"},"entries":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"ok":{"type":"boolean","description":"Whether a certificate is served for it"},"error":{"description":"Why not, as the TLS handshake said it","type":"string"}},"required":["host","ok"],"additionalProperties":false},"description":"One entry per hostname the machine serves"}},"required":["at","entries"],"additionalProperties":false},{"type":"null"}],"description":"Certificate state a machine last reported, hostname by hostname; null: none yet"},"envChangedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the environment or a binding last changed; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was last changed"},"composeFile":{"description":"Compose apps with composeSource inline: the compose file text; null otherwise","type":["string","null"]},"defaultUrl":{"type":"string","description":"The app’s default hostname"}},"required":["id","orgId","name","slug","environmentId","gitRepositoryId","branch","deployOnPush","rootDir","imageRef","composeSource","composePath","composeService","composePort","hosting","memoryMb","idleSeconds","poolHostId","dataSavedAt","dataBytes","builder","buildCommand","startCommand","port","releaseCommand","releaseService","releaseTimeoutSec","healthCheck","composeHealthChecks","instanceType","replicas","locations","hetznerLoadBalancerId","loadBalancerIpv4","ecrRepositoryId","serviceAccountIamUserId","generation","activeDeploymentId","status","reconcileError","tlsReport","envChangedAt","createdAt","updatedAt","composeFile","defaultUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:CreateApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}":{"get":{"operationId":"deploy.apps.get","summary":"Describe an app with its environment, deployments, domains and machines","description":"`deploy:DescribeApp` Describe an app with its environment, deployments, domains and machines. Environment values are included only with deploy:ManageEnv, the compose file only with deploy:UpdateApp.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"app":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"App id"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the app belongs to"},"name":{"type":"string","description":"Display name"},"slug":{"type":"string","description":"Short name used in the default hostname, unique in the organization"},"environmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets only"},"gitRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Git repository the app builds from; null for an app that runs an image"},"branch":{"description":"Branch the app deploys from; null means the repository’s default branch","type":["string","null"]},"deployOnPush":{"type":"boolean","description":"Whether each commit pushed to the branch is deployed"},"rootDir":{"type":"string","description":"Directory in the repository the app is built from"},"imageRef":{"description":"Container image the app runs, for builder image; null otherwise","type":["string","null"]},"composeSource":{"anyOf":[{"type":"string","enum":["inline","git"]},{"type":"null"}],"description":"Compose apps: where the compose file comes from; null for other builders"},"composePath":{"description":"Compose apps with composeSource git: path of the compose file in the repository","type":["string","null"]},"composeService":{"description":"Compose apps: the service published on the app’s domains","type":["string","null"]},"composePort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Compose apps: the container port of composeService that receives traffic"},"hosting":{"type":"string","enum":["machine","pooled"],"description":"machine: its own machines; pooled: a Next.js app on shared hosts"},"memoryMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: memory reserved for the app’s server while it runs, in MB"},"idleSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: seconds without a request after which the server is stopped"},"poolHostId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Pooled hosting: the shared host the app is placed on; null until placed"},"dataSavedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Pooled hosting: when the app’s data directory was last saved; null if never"},"dataBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the last saved data directory, in bytes"},"builder":{"type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose","nextjs"],"description":"How the app is built; nextjs for pooled hosting"},"buildCommand":{"description":"Build command replacing the detected one; null: the detected one","type":["string","null"]},"startCommand":{"description":"Start command replacing the detected one; null: the detected one","type":["string","null"]},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port the app listens on in its container"},"releaseCommand":{"description":"Command run once per deployment before traffic moves; null: none","type":["string","null"]},"releaseService":{"description":"Compose apps: service the release command runs in; null: the published service","type":["string","null"]},"releaseTimeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds the release command may run"},"healthCheck":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false},{"type":"null"}],"description":"HTTP check a new container must pass; null means GET / below 500"},"composeHealthChecks":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false}},{"type":"null"}],"description":"Compose apps: health checks of other services, by service name; null: none"},"instanceType":{"type":"string","description":"Machine size of each machine (pooled for pooled hosting), e.g. performance-2"},"replicas":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of machines"},"locations":{"type":"array","items":{"type":"string"},"description":"Locations the machines are spread over in order; empty: the region’s own location"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The app’s load balancer, when it has more than one machine or location; else null"},"loadBalancerIpv4":{"description":"Public address of the app’s load balancer; null without one","type":["string","null"]},"ecrRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Repository of the organization’s registry the app pulls from; null: none"},"serviceAccountIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The app’s own identity its machines sign in with; null until provisioned"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Counter raised with every new desired deployment; machines roll when it changes"},"activeDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The deployment live now; null before the first one"},"status":{"type":"string","enum":["created","provisioning","active","suspended","error","deleting"],"description":"created, provisioning, active, suspended, error or deleting"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"tlsReport":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When a machine reported"},"entries":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"ok":{"type":"boolean","description":"Whether a certificate is served for it"},"error":{"description":"Why not, as the TLS handshake said it","type":"string"}},"required":["host","ok"],"additionalProperties":false},"description":"One entry per hostname the machine serves"}},"required":["at","entries"],"additionalProperties":false},{"type":"null"}],"description":"Certificate state a machine last reported, hostname by hostname; null: none yet"},"envChangedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the environment or a binding last changed; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was last changed"},"composeFile":{"description":"Compose file text; null without one or without deploy:UpdateApp","type":["string","null"]},"defaultUrl":{"type":"string","description":"The app’s default hostname"}},"required":["id","orgId","name","slug","environmentId","gitRepositoryId","branch","deployOnPush","rootDir","imageRef","composeSource","composePath","composeService","composePort","hosting","memoryMb","idleSeconds","poolHostId","dataSavedAt","dataBytes","builder","buildCommand","startCommand","port","releaseCommand","releaseService","releaseTimeoutSec","healthCheck","composeHealthChecks","instanceType","replicas","locations","hetznerLoadBalancerId","loadBalancerIpv4","ecrRepositoryId","serviceAccountIamUserId","generation","activeDeploymentId","status","reconcileError","tlsReport","envChangedAt","createdAt","updatedAt","composeFile","defaultUrl"],"additionalProperties":false,"description":"The app with all its settings"},"env":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Variable id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain (a value) or secret (a bound Secret)"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound to a secret variable; null for plain, or when it was deleted"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was first set"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","key","valueKind","plainValue","kmsSecretId","createdAt","updatedAt"],"additionalProperties":false},"description":"Its variables; empty without deploy:ManageEnv (see envRedacted)"},"envRedacted":{"type":"boolean","description":"True when the variables were withheld"},"composeFileRedacted":{"type":"boolean","description":"True when the compose file was withheld"},"deployments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt"],"additionalProperties":false},"description":"The last 50 deployments, newest first"},"domains":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Domain id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app it serves"},"domain":{"type":"string","description":"Hostname, or *.host for every subdomain"},"isPrimary":{"type":"boolean","description":"Whether it is the app’s primary domain"},"tlsStatus":{"type":"string","enum":["pending","active","failed"],"description":"Certificate state"},"dnsVerifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last seen pointing at the app; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","domain","isPrimary","tlsStatus","dnsVerifiedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Custom domains"},"targets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Target id"},"deploymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment the machine was set up for"},"health":{"type":"string","enum":["pending","healthy","unhealthy","stale"],"description":"As of now; stale when the machine stopped reporting"},"lastReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last report about this deployment; null if none"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the target was created"},"sync":{"type":"string","enum":["in_sync","out_of_sync","unknown"],"description":"Whether the machine runs the deployment it should"},"syncReason":{"type":"string","description":"Why, in one sentence"},"rollingOut":{"type":"boolean","description":"Out of sync only because a rollout is in progress"},"expected":{"anyOf":[{"type":"object","properties":{"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"App generation"},"imageRef":{"description":"Image; null for compose","type":["string","null"]},"composeDigest":{"description":"Compose file digest; null for an image","type":["string","null"]}},"required":["generation","imageRef","composeDigest"],"additionalProperties":false},{"type":"null"}],"description":"What it should run; null when nothing is desired"},"running":{"anyOf":[{"type":"object","properties":{"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"App generation"},"imageRef":{"description":"Image; null for compose","type":["string","null"]},"composeDigest":{"description":"Compose file digest; null for an image","type":["string","null"]}},"required":["generation","imageRef","composeDigest"],"additionalProperties":false},{"type":"null"}],"description":"What it says it runs; null before its first report"},"driftSince":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Since when it runs something else; null while in sync"},"reportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it last reported anything; null if never"},"instance":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Instance id (i-…)"},"name":{"description":"Instance name","type":["string","null"]},"state":{"type":"string","description":"Instance state, e.g. running"},"publicIp":{"description":"Public IPv4 address; null if none","type":["string","null"]},"regionId":{"type":"string","description":"Region"},"serverType":{"description":"Instance type; null if unknown","type":["string","null"]}},"required":["id","name","state","publicIp","regionId","serverType"],"additionalProperties":false},{"type":"null"}],"description":"The machine; null when it was deleted"}},"required":["id","deploymentId","health","lastReportedAt","createdAt","sync","syncReason","rollingOut","expected","running","driftSince","reportedAt","instance"],"additionalProperties":false},"description":"Each machine with its health and sync"}},"required":["app","env","envRedacted","composeFileRedacted","deployments","domains","targets"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-soft-action":"deploy:ManageEnv"},"patch":{"operationId":"deploy.apps.update","summary":"Change an app, including its release command and health checks","description":"`deploy:UpdateApp` Change an app, including its release command and health checks. Takes effect on the next deployment.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"New display name","type":"string","minLength":1,"maxLength":64},"branch":{"description":"Branch the app deploys from; null returns to the repository’s default branch","anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"deployOnPush":{"description":"Whether each commit pushed to the branch is deployed","type":"boolean"},"rootDir":{"description":"Directory in the repository the app is built from","type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9._/-]+$"},"builder":{"description":"How the app is built: railpack, dockerfile, image or compose (see Create an app)","type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose"]},"buildCommand":{"description":"Replaces the detected build command; null returns to the detected one","anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"startCommand":{"description":"Replaces the detected start command; null returns to the detected one","anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"imageRef":{"description":"Container image the app runs, for builder image","type":"string","minLength":1,"maxLength":512,"pattern":"^[a-z0-9]([a-z0-9._-]*[a-z0-9])?(:[0-9]+)?(\\/[a-z0-9]([a-z0-9._-]*[a-z0-9])?)*(:[A-Za-z0-9._-]+|@sha256:[a-f0-9]{64})?$"},"composeSource":{"description":"Compose apps: inline (composeFile) or git (composePath in the repository)","type":"string","enum":["inline","git"]},"composeFile":{"description":"Compose apps: the new compose file text, checked when saved","type":"string","maxLength":131072},"composePath":{"description":"Compose apps: path of the compose file in the repository","type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9._/-]+$"},"composeService":{"description":"Compose apps: the service published on the app’s domains","type":"string","minLength":1,"maxLength":63},"composePort":{"description":"Compose apps: the container port of composeService that receives traffic","type":"integer","minimum":1,"maximum":65535},"port":{"description":"Port the app listens on in its container","type":"integer","minimum":1,"maximum":65535},"instanceType":{"description":"Machine size of each machine, an instance type, e.g. performance-2 (the provider’s own names are still accepted, deprecated)","type":"string","minLength":1,"maxLength":32},"replicas":{"description":"Number of machines; more than one puts a load balancer in front","type":"integer","minimum":1,"maximum":10},"locations":{"description":"Locations the machines are spread over in order, all in one region (e.g. fsn1, nbg1); empty means the region’s own location","maxItems":3,"type":"array","items":{"type":"string","pattern":"^[a-z]{3}\\d$"}},"releaseCommand":{"description":"Command run once per deployment with /bin/sh -c in the new image, before traffic moves to it (e.g. database migrations); null or omitted runs none","anyOf":[{"type":"string","minLength":1,"maxLength":4096},{"type":"null"}]},"releaseService":{"description":"Compose apps: the service whose image and environment run the release command; omitted or null, the published service","anyOf":[{"type":"string","minLength":1,"maxLength":63},{"type":"null"}]},"releaseTimeoutSec":{"description":"Seconds the release command may run before the deployment fails; a new app gets 600","type":"integer","minimum":10,"maximum":3600},"healthCheck":{"description":"The HTTP check a new container must pass before it gets traffic; null or omitted means GET / on the app port, any status below 500","anyOf":[{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512,"pattern":"^\\/[A-Za-z0-9._~!$&'()*+,;=:@%/?-]*$"},"port":{"type":"integer","minimum":1,"maximum":65535},"expectedStatus":{"type":"integer","minimum":100,"maximum":599},"timeoutSec":{"type":"integer","minimum":5,"maximum":1800}},"required":["path"]},{"type":"null"}]},"composeHealthChecks":{"description":"Compose apps: health checks for services other than the published one, keyed by service name","anyOf":[{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512,"pattern":"^\\/[A-Za-z0-9._~!$&'()*+,;=:@%/?-]*$"},"port":{"type":"integer","minimum":1,"maximum":65535},"expectedStatus":{"type":"integer","minimum":100,"maximum":599},"timeoutSec":{"type":"integer","minimum":5,"maximum":1800}},"required":["path"]}},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"App id"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the app belongs to"},"name":{"type":"string","description":"Display name"},"slug":{"type":"string","description":"Short name used in the default hostname, unique in the organization"},"environmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Secrets environment the app runs in, which decides which secret a name resolves to; null: shared secrets only"},"gitRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Git repository the app builds from; null for an app that runs an image"},"branch":{"description":"Branch the app deploys from; null means the repository’s default branch","type":["string","null"]},"deployOnPush":{"type":"boolean","description":"Whether each commit pushed to the branch is deployed"},"rootDir":{"type":"string","description":"Directory in the repository the app is built from"},"imageRef":{"description":"Container image the app runs, for builder image; null otherwise","type":["string","null"]},"composeSource":{"anyOf":[{"type":"string","enum":["inline","git"]},{"type":"null"}],"description":"Compose apps: where the compose file comes from; null for other builders"},"composePath":{"description":"Compose apps with composeSource git: path of the compose file in the repository","type":["string","null"]},"composeService":{"description":"Compose apps: the service published on the app’s domains","type":["string","null"]},"composePort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Compose apps: the container port of composeService that receives traffic"},"hosting":{"type":"string","enum":["machine","pooled"],"description":"machine: its own machines; pooled: a Next.js app on shared hosts"},"memoryMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: memory reserved for the app’s server while it runs, in MB"},"idleSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pooled hosting: seconds without a request after which the server is stopped"},"poolHostId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Pooled hosting: the shared host the app is placed on; null until placed"},"dataSavedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Pooled hosting: when the app’s data directory was last saved; null if never"},"dataBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the last saved data directory, in bytes"},"builder":{"type":"string","enum":["railpack","dockerfile","forgejo_actions","image","compose","nextjs"],"description":"How the app is built; nextjs for pooled hosting"},"buildCommand":{"description":"Build command replacing the detected one; null: the detected one","type":["string","null"]},"startCommand":{"description":"Start command replacing the detected one; null: the detected one","type":["string","null"]},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port the app listens on in its container"},"releaseCommand":{"description":"Command run once per deployment before traffic moves; null: none","type":["string","null"]},"releaseService":{"description":"Compose apps: service the release command runs in; null: the published service","type":["string","null"]},"releaseTimeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds the release command may run"},"healthCheck":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false},{"type":"null"}],"description":"HTTP check a new container must pass; null means GET / below 500"},"composeHealthChecks":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"path":{"type":"string","description":"Path requested with GET on the container"},"port":{"description":"Container port probed; absent means the app’s (or published service’s) port","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatus":{"description":"The one HTTP status that counts as healthy; absent means any status below 500","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"timeoutSec":{"description":"Seconds a new container has to start answering","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path"],"additionalProperties":false}},{"type":"null"}],"description":"Compose apps: health checks of other services, by service name; null: none"},"instanceType":{"type":"string","description":"Machine size of each machine (pooled for pooled hosting), e.g. performance-2"},"replicas":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of machines"},"locations":{"type":"array","items":{"type":"string"},"description":"Locations the machines are spread over in order; empty: the region’s own location"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The app’s load balancer, when it has more than one machine or location; else null"},"loadBalancerIpv4":{"description":"Public address of the app’s load balancer; null without one","type":["string","null"]},"ecrRepositoryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Repository of the organization’s registry the app pulls from; null: none"},"serviceAccountIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The app’s own identity its machines sign in with; null until provisioned"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Counter raised with every new desired deployment; machines roll when it changes"},"activeDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The deployment live now; null before the first one"},"status":{"type":"string","enum":["created","provisioning","active","suspended","error","deleting"],"description":"created, provisioning, active, suspended, error or deleting"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"tlsReport":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When a machine reported"},"entries":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"ok":{"type":"boolean","description":"Whether a certificate is served for it"},"error":{"description":"Why not, as the TLS handshake said it","type":"string"}},"required":["host","ok"],"additionalProperties":false},"description":"One entry per hostname the machine serves"}},"required":["at","entries"],"additionalProperties":false},{"type":"null"}],"description":"Certificate state a machine last reported, hostname by hostname; null: none yet"},"envChangedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the environment or a binding last changed; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the app was last changed"},"composeFile":{"description":"Compose apps with composeSource inline: the compose file text; null otherwise","type":["string","null"]},"defaultUrl":{"type":"string","description":"The app’s default hostname"}},"required":["id","orgId","name","slug","environmentId","gitRepositoryId","branch","deployOnPush","rootDir","imageRef","composeSource","composePath","composeService","composePort","hosting","memoryMb","idleSeconds","poolHostId","dataSavedAt","dataBytes","builder","buildCommand","startCommand","port","releaseCommand","releaseService","releaseTimeoutSec","healthCheck","composeHealthChecks","instanceType","replicas","locations","hetznerLoadBalancerId","loadBalancerIpv4","ecrRepositoryId","serviceAccountIamUserId","generation","activeDeploymentId","status","reconcileError","tlsReport","envChangedAt","createdAt","updatedAt","composeFile","defaultUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:UpdateApp","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"deploy.apps.delete","summary":"Delete an app","description":"`deploy:DeleteApp` Delete an app.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"status":{"type":"string","enum":["created","provisioning","active","suspended","error","deleting"],"description":"deleting: the teardown runs in the background"}},"required":["id","status"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeleteApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/bundles":{"post":{"operationId":"deploy.hosting.create-bundle","summary":"Start a deployment of a pooled app from a build: returns an upload URL for the bundle","description":"`deploy:DeployApp` Start a deployment of a pooled app from a build: returns an upload URL for the bundle. The bundle is a tar.gz of .next/standalone, .next/static, .next/server, .next/ews-outputs.json and public/ (the starter template workflow makes it). PUT it to uploadUrl within an hour, then call complete-bundle. A commit on the app branch (default main) becomes production; any other branch a preview at its own URL.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"commitSha":{"type":"string","minLength":4,"maxLength":64,"pattern":"^[0-9A-Za-z._-]+$","description":"The commit the bundle was built from; also names its preview URL"},"branch":{"description":"The branch the commit was pushed to: the app’s branch (default main) makes it production, any other a preview; omitted or null counts as production","anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the tar.gz, in hex; checked again after download"},"sizeBytes":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824,"description":"Exact size of the tar.gz in bytes; completing fails if the upload differs"}},"required":["commitSha","sha256","sizeBytes"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deploymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The deployment started for the bundle"},"preview":{"type":"boolean","description":"Whether it becomes a preview rather than production"},"uploadUrl":{"type":"string","description":"Presigned URL to PUT the tar.gz to"},"expiresInSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds the upload URL is valid (3600)"}},"required":["deploymentId","preview","uploadUrl","expiresInSeconds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeployApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/bundles/{deploymentId}/complete":{"post":{"operationId":"deploy.hosting.complete-bundle","summary":"Confirm a bundle upload: the deployment is served at its URLs","description":"`deploy:DeployApp` Confirm a bundle upload: the deployment is served at its URLs. Fails while the upload is missing or its size differs from the one announced.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"deploymentId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deploymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The deployment"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"Its status now, live once served"},"urls":{"type":"object","properties":{"preview":{"type":"string","description":"The deployment’s own URL"},"production":{"description":"The app’s URL; null for a preview","type":["string","null"]}},"required":["preview","production"],"additionalProperties":false,"description":"Where it is served"}},"required":["deploymentId","status","urls"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeployApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/cache":{"put":{"operationId":"deploy.cache.bind","summary":"Bind a managed Valkey cache (its private address, in the app’s VPC)","description":"`deploy:ManageCacheBinding` Bind a managed Valkey cache (its private address, in the app’s VPC). Generates {prefix}REDIS_URL and {prefix}VALKEY_URL (redis://default:<password>@<private address>:6379) at every rollout. Refused unless every machine of the app is in the cache’s VPC. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cacheClusterId":{"type":"string","pattern":"^ewc-[0-9a-f]{12}$","description":"The managed Valkey cache to bind"},"envPrefix":{"description":"Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"redeploy":{"description":"Also roll the live deployment onto the new configuration; default false","type":"boolean"}},"required":["cacheClusterId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"cacheClusterId":{"type":"string","description":"The bound cache"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","cacheClusterId","envPrefix","generatedKeys"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageCacheBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["cache:ModifyCacheCluster","deploy:DeployApp"]},"delete":{"operationId":"deploy.cache.unbind","summary":"Remove the binding (the cache is unchanged)","description":"`deploy:ManageCacheBinding` Remove the binding (the cache is unchanged).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"envPrefix","in":"query","required":false,"schema":{"description":"Which binding to remove, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageCacheBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/connections":{"get":{"operationId":"deploy.connections.get","summary":"Host (private or public, as the binding resolves it), port, database, role and the secret holding the password","description":"`deploy:DescribeApp` Host (private or public, as the binding resolves it), port, database, role and the secret holding the password. Resolved exactly as the next rollout resolves it; a binding that would fail the rollout carries `error` instead of `connection`. No password is returned: read it with `dcloud secrets secrets get-value <password.secretId>` (needs secrets:GetSecretValue on that secret, audited). DATABASE_URL is postgresql://<user>:<password>@<host>:<port>/<database>?sslmode=require.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"databases":{"type":"array","items":{"type":"object","properties":{"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"error":{"description":"Why the next rollout would fail for this binding; null when it resolves","type":["string","null"]},"connection":{"anyOf":[{"type":"object","properties":{"host":{"type":"string","description":"Host the app connects to"},"network":{"type":"string","enum":["private","public"],"description":"private: inside the app’s network; public: over the internet"},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port"},"database":{"type":"string","description":"Database"},"user":{"type":"string","description":"User (role)"},"password":{"type":"object","properties":{"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Secret holding the password"},"secretName":{"description":"Its name; null if it is gone","type":["string","null"]},"canReveal":{"type":"boolean","description":"Whether you may read its value"}},"required":["secretId","secretName","canReveal"],"additionalProperties":false,"description":"Where the password is; never the password itself"}},"required":["host","network","port","database","user","password"],"additionalProperties":false},{"type":"null"}],"description":"How the app connects; null when error is set"}},"required":["envPrefix","error","connection"],"additionalProperties":false},"description":"Managed Postgres bindings"},"caches":{"type":"array","items":{"type":"object","properties":{"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"error":{"description":"Why the next rollout would fail for this binding; null when it resolves","type":["string","null"]},"connection":{"anyOf":[{"type":"object","properties":{"host":{"type":"string","description":"Host the app connects to"},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port"},"tls":{"type":"boolean","description":"Whether the connection uses TLS (rediss://)"},"user":{"type":"string","const":"default","description":"User, always default"},"password":{"type":"object","properties":{"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Secret holding the password"},"secretName":{"description":"Its name; null if it is gone","type":["string","null"]},"canReveal":{"type":"boolean","description":"Whether you may read its value"}},"required":["secretId","secretName","canReveal"],"additionalProperties":false,"description":"Where the password is; never the password itself"}},"required":["host","port","tls","user","password"],"additionalProperties":false},{"type":"null"}],"description":"How the app connects; null when error is set"}},"required":["envPrefix","error","connection"],"additionalProperties":false},"description":"Managed cache bindings"},"brokers":{"type":"array","items":{"type":"object","properties":{"engine":{"type":"string","enum":["kafka","rabbitmq","docdb"],"description":"kafka, rabbitmq or docdb"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"error":{"description":"Why the next rollout would fail for this binding; null when it resolves","type":["string","null"]},"connection":{"anyOf":[{"type":"object","properties":{"identifier":{"type":"string","description":"Name of the cluster or broker"},"host":{"type":"string","description":"Kafka: the bootstrap list; otherwise the address to connect to"},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Port"},"nodes":{"type":"array","items":{"type":"string"},"description":"Every node as address:port"},"user":{"type":"string","description":"User the app signs in as"},"password":{"type":"object","properties":{"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Secret holding the password"},"secretName":{"description":"Its name; null if it is gone","type":["string","null"]},"canReveal":{"type":"boolean","description":"Whether you may read its value"}},"required":["secretId","secretName","canReveal"],"additionalProperties":false,"description":"Where the password is; never the password itself"}},"required":["identifier","host","port","nodes","user","password"],"additionalProperties":false},{"type":"null"}],"description":"How the app connects; null when error is set"}},"required":["engine","envPrefix","error","connection"],"additionalProperties":false},"description":"Kafka, RabbitMQ and Document Database bindings"}},"required":["databases","caches","brokers"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/database":{"put":{"operationId":"deploy.database.bind","summary":"Bind a managed Postgres database (a dedicated app role by default)","description":"`deploy:ManageDatabaseBinding` Bind a managed Postgres database (a dedicated app role by default). mode=app_role creates role app_<slug> and its database (or grants on an existing one); its password is a secret the binding reads at every rollout. mode=master hands the app the master credential. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dbInstanceId":{"type":"string","minLength":3,"maxLength":64,"description":"The managed Postgres database (instance) to bind"},"dbBranchId":{"description":"A branch of the database (ewbr-…) to connect to instead: the branch's master user and port, no pooler","type":"string","pattern":"^ewbr-[0-9a-f]{12}$"},"database":{"description":"Database inside the instance (app_role mode creates it if missing). Default: the app’s slug as a Postgres name; in master mode or for a branch, the instance’s own database","type":"string","pattern":"^[a-z_][a-z0-9_]{0,62}$"},"mode":{"description":"app_role (default): a role of the app’s own, its password kept in Secrets; master: the instance’s master credential","type":"string","enum":["app_role","master"]},"envPrefix":{"description":"Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"pooled":{"description":"Connect through the PgBouncer pooler (default true) or straight to Postgres on 5432; ignored for a branch","type":"boolean"},"redeploy":{"description":"Also roll the live deployment onto the new configuration; default false","type":"boolean"}},"required":["dbInstanceId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization"},"dbInstanceId":{"type":"string","description":"The bound database instance"},"database":{"type":"string","description":"Database inside the instance the app connects to"},"dbBranchId":{"description":"Branch of the database the app connects to instead; null: the database itself","type":["string","null"]},"mode":{"type":"string","enum":["app_role","master"],"description":"app_role: a role of the app’s own; master: the master credential"},"roleName":{"description":"The app’s role, for app_role; null for master","type":["string","null"]},"credentialSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret holding the role’s password, for app_role; null for master"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"pooled":{"type":"boolean","description":"Whether it connects through the connection pooler"},"status":{"type":"string","enum":["pending","ready","error"],"description":"pending, ready or error"},"statusMessage":{"description":"What was done, or what failed","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was bound"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","orgId","dbInstanceId","database","dbBranchId","mode","roleName","credentialSecretId","envPrefix","pooled","status","statusMessage","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDatabaseBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["rds:ModifyDBInstance","deploy:DeployApp"]},"delete":{"operationId":"deploy.database.unbind","summary":"Remove the binding (the role and its data are kept)","description":"`deploy:ManageDatabaseBinding` Remove the binding (the role and its data are kept).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"envPrefix","in":"query","required":false,"schema":{"description":"Which binding to remove, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDatabaseBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/database/rotate":{"post":{"operationId":"deploy.database.rotate","summary":"New password for the app role; redeploys by default","description":"`deploy:ManageDatabaseBinding` New password for the app role; redeploys by default.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"envPrefix":{"description":"Which database binding, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"redeploy":{"description":"Roll the live deployment onto the new password; default true, since new connections with the old password stop working at once","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"version":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The new version of the password secret; null if it could not be read back"}},"required":["version"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDatabaseBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["rds:ModifyDBInstance","deploy:DeployApp"]}},"/deploy/api/apps/{id}/deployments":{"get":{"operationId":"deploy.deployments.list","summary":"List the deployments of an app, newest first","description":"`deploy:DescribeApp` List the deployments of an app, newest first.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"deploy.deployments.create","summary":"Start a deployment of an app","description":"`deploy:DeployApp` Start a deployment of an app. imageRef deploys that image this once without changing the app. An image in this organization’s registry is resolved to a digest first. fromDeploymentId runs what that deployment ran; with trigger rollback it also restores the environment that deployment started with (restoreEnvironment, default true for a rollback, needs deploy:ManageEnv as well).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"default":"manual","description":"rollback marks the deployment as a rollback and, with fromDeploymentId, restores that deployment’s environment by default","type":"string","enum":["manual","rollback"]},"gitCommitSha":{"description":"Commit to build; omitted, the head of the app’s branch","type":"string","minLength":7,"maxLength":64},"imageRef":{"description":"Image to run for this deployment only; the app’s own image is not changed","type":"string","minLength":1,"maxLength":512,"pattern":"^[a-z0-9]([a-z0-9._-]*[a-z0-9])?(:[0-9]+)?(\\/[a-z0-9]([a-z0-9._-]*[a-z0-9])?)*(:[A-Za-z0-9._-]+|@sha256:[a-f0-9]{64})?$"},"fromDeploymentId":{"description":"An earlier deployment of this app to run again: its image or pinned compose file, commit and release command","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"description":"Why, shown on the deployment timeline beside who started it","type":"string","minLength":1,"maxLength":500},"restoreEnvironment":{"description":"With fromDeploymentId: also put back the environment that deployment started with; default true for a rollback, false otherwise","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeployApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/docdb":{"put":{"operationId":"deploy.docdb.bind","summary":"Bind a Document Database cluster (MongoDB-compatible) as one of its users","description":"`deploy:ManageBrokerBinding` Bind a Document Database cluster (MongoDB-compatible) as one of its users. Generates {prefix}MONGODB_URL (mongodb://user:password@<host>:27017/?tls=true&authMechanism=SCRAM-SHA-256&authSource=admin&directConnection=true&tlsCAFile=<the platform CA in the container>) at every rollout, and on a 3-node cluster {prefix}MONGODB_READER_URL (the same on port 27018: the replicas, reads only, may lag). A private cluster needs the app’s machines in its VPC; a public one is reachable from anywhere. Needs secrets:GetSecretValue on that user’s password. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$","description":"The Document Database cluster to bind"},"userName":{"type":"string","description":"The user the app signs in as: the cluster’s master user (masterUsername) or one of its users"},"envPrefix":{"description":"Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"redeploy":{"description":"Also roll the live deployment onto the new configuration; default false","type":"boolean"}},"required":["clusterId","userName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"engine":{"type":"string","enum":["kafka","rabbitmq","docdb"],"description":"kafka, rabbitmq or docdb"},"resourceId":{"type":"string","description":"The bound cluster or broker"},"userName":{"type":"string","description":"User the app signs in as"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","engine","resourceId","userName","envPrefix","generatedKeys"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:GetSecretValue","deploy:DeployApp"]},"delete":{"operationId":"deploy.docdb.unbind","summary":"Remove the binding (the cluster is unchanged)","description":"`deploy:ManageBrokerBinding` Remove the binding (the cluster is unchanged).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"envPrefix","in":"query","required":false,"schema":{"description":"Which binding to remove, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/domains":{"get":{"operationId":"deploy.domains.list","summary":"List the custom domains of an app","description":"`deploy:DescribeApp` List the custom domains of an app.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Domain id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app it serves"},"domain":{"type":"string","description":"Hostname, or *.host for every subdomain"},"isPrimary":{"type":"boolean","description":"Whether it is the app’s primary domain"},"tlsStatus":{"type":"string","enum":["pending","active","failed"],"description":"Certificate state"},"dnsVerifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last seen pointing at the app; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","domain","isPrimary","tlsStatus","dnsVerifiedAt","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"deploy.domains.add","summary":"Attach a custom domain to an app","description":"`deploy:ManageDomain` Attach a custom domain to an app.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253,"pattern":"^(\\*\\.)?[a-z0-9.-]+$","description":"Hostname to serve the app on, or *.host for every subdomain of host"},"isPrimary":{"description":"Mark this as the app’s primary domain; default false","type":"boolean"}},"required":["domain"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Domain id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app it serves"},"domain":{"type":"string","description":"Hostname, or *.host for every subdomain"},"isPrimary":{"type":"boolean","description":"Whether it is the app’s primary domain"},"tlsStatus":{"type":"string","enum":["pending","active","failed"],"description":"Certificate state"},"dnsVerifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last seen pointing at the app; null if never"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","domain","isPrimary","tlsStatus","dnsVerifiedAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDomain","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/domains/{domainId}":{"delete":{"operationId":"deploy.domains.remove","summary":"Detach a custom domain","description":"`deploy:ManageDomain` Detach a custom domain.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed domain"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDomain","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/domains/{domainId}/verify":{"post":{"operationId":"deploy.domains.verify","summary":"Check that a custom domain points at the app, and record it","description":"`deploy:ManageDomain` Check that a custom domain points at the app, and record it.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"url":{"type":"string","description":"URL the app answers at"},"kind":{"type":"string","enum":["default","custom"],"description":"default: the platform name; custom: a domain"},"wildcard":{"type":"boolean","description":"A *.host domain covering every name one label below"},"domainId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The custom domain’s id; null for the default host"},"isPrimary":{"type":"boolean","description":"Whether it is the primary domain"},"platformManaged":{"type":"boolean","description":"True when the platform nameservers answer for it with no action from you"},"hostedZone":{"anyOf":[{"type":"object","properties":{"zoneId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Hosted zone id"},"zoneName":{"type":"string","description":"Zone name"},"answersForApp":{"type":"boolean","description":"Whether the zone holds a record pointing at the app"},"delegation":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["delegated","elsewhere","pending"],"description":"Delegation state"},"detail":{"type":"string","description":"One sentence about it"},"checkedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last checked; null if never"}},"required":["status","detail","checkedAt"],"additionalProperties":false},{"type":"null"}],"description":"Whether the zone is delegated; null when you may not read the zone"}},"required":["zoneId","zoneName","answersForApp","delegation"],"additionalProperties":false},{"type":"null"}],"description":"Your hosted zone that answers for the name; null outside every zone"},"requiredRecord":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["A","CNAME","ALIAS"],"description":"Record type"},"name":{"type":"string","description":"Record name"},"value":{"type":"string","description":"Record value"},"note":{"type":"string","description":"Why this record"}},"required":["type","name","value","note"],"additionalProperties":false},{"type":"null"}],"description":"The DNS record to create; null when the platform answers for the name"},"dns":{"type":"object","properties":{"state":{"type":"string","enum":["ok","mismatch","missing","unknown"],"description":"What DNS answers now"},"observed":{"type":"array","items":{"type":"string"},"description":"Addresses or CNAME targets DNS returned"},"expectedIp":{"description":"Address the name should resolve to; null before the first deployment","type":["string","null"]},"detail":{"type":"string","description":"One sentence about it"}},"required":["state","observed","expectedIp","detail"],"additionalProperties":false,"description":"DNS, resolved live"},"tls":{"type":"object","properties":{"state":{"type":"string","enum":["active","pending","failed","unavailable","on-demand"],"description":"Certificate state; on-demand for a wildcard, one per name on first request"},"detail":{"type":"string","description":"Why, in one sentence"},"reportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the machine last reported on it; null if never"}},"required":["state","detail","reportedAt"],"additionalProperties":false,"description":"The certificate"}},"required":["host","url","kind","wildcard","domainId","isPrimary","platformManaged","hostedZone","requiredRecord","dns","tls"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageDomain","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/env":{"get":{"operationId":"deploy.env.get","summary":"Variables with sync status, database bindings, and whether a redeploy is pending","description":"`deploy:ManageEnv` Variables with sync status, database bindings, and whether a redeploy is pending.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"vars":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The bound Secret; null for plain"},"secret":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"},"name":{"type":"string","description":"Secret name"},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"},"name":{"type":"string","description":"Its name"},"provider":{"type":"string","description":"Its provider, e.g. 1password"}},"required":["id","name","provider"],"additionalProperties":false},{"type":"null"}],"description":"The external source it is synced from; null for an ordinary secret"},"sourceRef":{"description":"Reference in the source, e.g. op://vault/item/field; null if none","type":["string","null"]},"syncStatus":{"anyOf":[{"type":"string","enum":["ok","error"]},{"type":"null"}],"description":"Outcome of the last sync; null for an ordinary secret"},"syncError":{"description":"Why the last sync failed","type":["string","null"]},"lastSyncedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last synced"}},"required":["id","name","source","sourceRef","syncStatus","syncError","lastSyncedAt"],"additionalProperties":false},{"type":"null"}],"description":"The bound Secret; null for plain, or when it was deleted"}},"required":["key","valueKind","plainValue","kmsSecretId","secret"],"additionalProperties":false},"description":"The variables set on the app"},"databaseBindings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"dbInstanceId":{"type":"string","description":"The database instance"},"dbIdentifier":{"description":"Its name; null if it is gone","type":["string","null"]},"database":{"type":"string","description":"Database the app connects to"},"mode":{"type":"string","enum":["app_role","master"],"description":"app_role or master"},"roleName":{"description":"The app’s role; null for master","type":["string","null"]},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"pooled":{"type":"boolean","description":"Whether it connects through the pooler"},"status":{"type":"string","enum":["pending","ready","error"],"description":"pending, ready or error"},"statusMessage":{"description":"What was done, or what failed","type":["string","null"]},"unreachable":{"description":"Why the app’s machines cannot reach it; null when they can","type":["string","null"]},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","dbInstanceId","dbIdentifier","database","mode","roleName","envPrefix","pooled","status","statusMessage","unreachable","generatedKeys"],"additionalProperties":false},"description":"Managed Postgres bindings"},"cacheBindings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"cacheClusterId":{"type":"string","description":"The cache"},"cacheIdentifier":{"description":"Its name; null if it is gone","type":["string","null"]},"cacheStatus":{"description":"Its status; null if it is gone","type":["string","null"]},"privateAddress":{"description":"Its private address; null until it has one","type":["string","null"]},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","cacheClusterId","cacheIdentifier","cacheStatus","privateAddress","envPrefix","generatedKeys"],"additionalProperties":false},"description":"Managed cache bindings"},"brokerBindings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"engine":{"type":"string","enum":["kafka","rabbitmq","docdb"],"description":"kafka, rabbitmq or docdb"},"resourceId":{"description":"The cluster or broker","type":["string","null"]},"identifier":{"description":"Its name; null if it is gone","type":["string","null"]},"status":{"description":"Its status; null if it is gone","type":["string","null"]},"userName":{"type":"string","description":"User the app signs in as"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","engine","resourceId","identifier","status","userName","envPrefix","generatedKeys"],"additionalProperties":false},"description":"Kafka, RabbitMQ and Document Database bindings"},"status":{"type":"object","properties":{"pending":{"type":"boolean","description":"True when the live deployment runs an older configuration"},"liveDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The live deployment; null if none"},"liveGeneration":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Its generation"},"reasons":{"type":"array","items":{"type":"string"},"description":"Why a redeploy is pending"}},"required":["pending","liveDeploymentId","liveGeneration","reasons"],"additionalProperties":false,"description":"Whether the saved configuration is running"}},"required":["vars","databaseBindings","cacheBindings","brokerBindings","status"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageEnv","x-ews-mutates":true,"x-ews-sensitive":false},"put":{"operationId":"deploy.env.replace","summary":"Replace the whole environment of an app","description":"`deploy:ManageEnv` Replace the whole environment of an app. Binding a secret needs secrets:GetSecretValue on it and grants it to the deploy consumer. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vars":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z_][A-Za-z0-9_]*$"},"valueKind":{"type":"string","enum":["plain","secret"]},"plainValue":{"type":"string","maxLength":8192},"kmsSecretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["key","valueKind"]},"description":"The complete environment: each entry is a key with valueKind plain (and plainValue, one line) or secret (and kmsSecretId, the Secret to bind). Keys left out are removed"},"redeploy":{"description":"Also roll the live deployment onto the new environment; default false","type":"boolean"}},"required":["vars"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Variable id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain (a value) or secret (a bound Secret)"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound to a secret variable; null for plain, or when it was deleted"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was first set"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","key","valueKind","plainValue","kmsSecretId","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageEnv","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:GetSecretValue","deploy:DeployApp"]}},"/deploy/api/apps/{id}/env/export":{"get":{"operationId":"deploy.env.export","summary":"The environment as .env text — plain values, references, secret names; no secret values","description":"`deploy:ManageEnv` The environment as .env text — plain values, references, secret names; no secret values.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"content":{"type":"string","description":"The .env text"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of variables set on the app"}},"required":["content","count"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageEnv","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/env/import":{"post":{"operationId":"deploy.env.import","summary":"Import a .env or .env.op file — dry run for the plan, then apply atomically","description":"`deploy:ManageEnv` Import a .env or .env.op file — dry run for the plan, then apply atomically. dcloud deploy env import <appId> --content \"$(cat .env.op)\" --preview. op:// references become synced secrets; sensitive-looking values become secrets, the rest plain (override per key with classify); dcloud-secret://NAME (or ews-secret://NAME) binds an existing secret. mode=merge keeps keys the file omits, replace removes them. Nothing is applied if any key has an error. No value is ever echoed back. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","maxLength":524288,"description":"The .env / .env.op file text"},"mode":{"description":"merge (default) keeps variables the file does not mention; replace removes them","type":"string","enum":["merge","replace"]},"classify":{"description":"Per key, plain or secret, overriding the kind the import would pick","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z_][A-Za-z0-9_]*$"},"additionalProperties":{"type":"string","enum":["plain","secret"]}},"source":{"description":"Secret source (by name) for NEW op:// references, needed only when several sources reach the vault","anyOf":[{"type":"string","minLength":2,"maxLength":63},{"type":"null"}]},"sourceId":{"description":"The same secret source as source, by id (the older spelling)","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"keyId":{"description":"KMS key new secrets are encrypted under; default the organization’s default key","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"preview":{"description":"Return the plan without changing anything; default false","type":"boolean"},"redeploy":{"description":"Also roll the live deployment onto the imported environment; default false, ignored with preview","type":"boolean"}},"required":["content"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"applied":{"type":"boolean","description":"False for a preview: nothing was changed"},"plan":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"kind":{"type":"string","enum":["plain","secret","reference","existing-secret","removed"],"description":"What it becomes"},"change":{"type":"string","enum":["add","update","unchanged","remove","error"],"description":"What happens to it"},"reason":{"type":"string","description":"Why it was classified so"},"detail":{"type":"string","description":"What applying does, in a sentence"},"error":{"description":"Why it cannot be applied; null if it can","type":["string","null"]},"line":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Line in the file; null for a removal"}},"required":["key","kind","change","reason","detail","error","line"],"additionalProperties":false},"description":"Per key, what happens to it"},"issues":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Line in the file"},"key":{"description":"Variable name, if one could be read","type":["string","null"]},"message":{"type":"string","description":"What is wrong"}},"required":["line","key","message"],"additionalProperties":false},"description":"Lines that could not be read"},"summary":{"type":"object","properties":{"add":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Variables added"},"update":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Variables changed"},"unchanged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Variables left as they are"},"remove":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Variables removed"},"error":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Variables with an error"}},"required":["add","update","unchanged","remove","error"],"additionalProperties":false,"description":"Counts by change"},"applicable":{"type":"boolean","description":"False when any item has an error; nothing is applied then"}},"required":["items","issues","summary","applicable"],"additionalProperties":false,"description":"The plan"}},"required":["applied","plan"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageEnv","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CreateSecret","secrets:RotateSecret","secrets:UseSecretSource","secrets:GetSecretValue","deploy:DeployApp"]}},"/deploy/api/apps/{id}/errors":{"get":{"operationId":"deploy.errors.get","summary":"The app’s Error Tracking binding: project, variable names, environment, DSN","description":"`deploy:DescribeApp` The app’s Error Tracking binding: project, variable names, environment, DSN.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Error Tracking project"},"projectName":{"type":"string","description":"Project name; (deleted project) if it was deleted"},"projectSlug":{"type":"string","description":"Project slug; empty if it was deleted"},"dsnEnv":{"type":"string","description":"Variable the DSN is set in"},"publicDsnEnv":{"type":"string","description":"Variable the browser DSN is set in"},"environmentEnv":{"type":"string","description":"Variable the environment name is set in"},"releaseEnv":{"type":"string","description":"Variable the release (commit) is set in"},"environment":{"description":"Environment name as set; null: taken from the app","type":["string","null"]},"effectiveEnvironment":{"type":"string","description":"The environment name the app reports"},"overriddenByApp":{"type":"array","items":{"type":"string"},"description":"Generated names the app sets itself, which win over the binding"},"ownAuthToken":{"type":"boolean","description":"True when the app sets its own SENTRY_AUTH_TOKEN: no token is minted per build"},"dsn":{"description":"The DSN (send-only); null when the project has no key","type":["string","null"]},"secretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret holding the project key; null if none"},"secretName":{"description":"Its name","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was connected"}},"required":["id","projectId","projectName","projectSlug","dsnEnv","publicDsnEnv","environmentEnv","releaseEnv","environment","effectiveEnvironment","overriddenByApp","ownAuthToken","dsn","secretId","secretName","createdAt"],"additionalProperties":false},{"type":"null"}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"deploy.errors.connect","summary":"Connect Error Tracking: DSN, environment and release at build and run time","description":"`deploy:ManageErrorsBinding` Connect Error Tracking: DSN, environment and release at build and run time. At every build and rollout the app gets SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN (the project’s managed key, filed in Secrets as a managed entry), SENTRY_ENVIRONMENT and SENTRY_RELEASE (the commit). A build also gets SENTRY_ORG, SENTRY_PROJECT, SENTRY_URL and, as a BuildKit secret, a SENTRY_AUTH_TOKEN minted for that build alone (source-map upload to this project only), revoked when the build ends. A variable the app defines itself wins. With redeploy: true the live commit is rebuilt, so the DSN reaches the browser bundle and source maps are uploaded.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Error Tracking project id"},"dsnEnv":{"description":"Server DSN variable (default SENTRY_DSN)","type":"string","pattern":"^([A-Za-z_][A-Za-z0-9_]{0,127})?$"},"publicDsnEnv":{"description":"Browser DSN variable (default NEXT_PUBLIC_SENTRY_DSN; VITE_SENTRY_DSN or PUBLIC_SENTRY_DSN for Vite and SvelteKit)","type":"string","pattern":"^([A-Za-z_][A-Za-z0-9_]{0,127})?$"},"environmentEnv":{"description":"Environment variable (default SENTRY_ENVIRONMENT)","type":"string","pattern":"^([A-Za-z_][A-Za-z0-9_]{0,127})?$"},"releaseEnv":{"description":"Release variable (default SENTRY_RELEASE)","type":"string","pattern":"^([A-Za-z_][A-Za-z0-9_]{0,127})?$"},"environment":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[^\\s/]+$","description":"SENTRY_ENVIRONMENT; omitted: the app’s secrets environment, else production"},{"type":"null"}]},"redeploy":{"description":"Rebuild and redeploy now, so the build bakes the DSN into the browser bundle and uploads source maps","type":"boolean"}},"required":["projectId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Error Tracking project"},"projectName":{"type":"string","description":"Project name; (deleted project) if it was deleted"},"projectSlug":{"type":"string","description":"Project slug; empty if it was deleted"},"dsnEnv":{"type":"string","description":"Variable the DSN is set in"},"publicDsnEnv":{"type":"string","description":"Variable the browser DSN is set in"},"environmentEnv":{"type":"string","description":"Variable the environment name is set in"},"releaseEnv":{"type":"string","description":"Variable the release (commit) is set in"},"environment":{"description":"Environment name as set; null: taken from the app","type":["string","null"]},"effectiveEnvironment":{"type":"string","description":"The environment name the app reports"},"overriddenByApp":{"type":"array","items":{"type":"string"},"description":"Generated names the app sets itself, which win over the binding"},"ownAuthToken":{"type":"boolean","description":"True when the app sets its own SENTRY_AUTH_TOKEN: no token is minted per build"},"dsn":{"description":"The DSN (send-only); null when the project has no key","type":["string","null"]},"secretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret holding the project key; null if none"},"secretName":{"description":"Its name","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was connected"}},"required":["id","projectId","projectName","projectSlug","dsnEnv","publicDsnEnv","environmentEnv","releaseEnv","environment","effectiveEnvironment","overriddenByApp","ownAuthToken","dsn","secretId","secretName","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageErrorsBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["errors:UpdateProject","deploy:DeployApp"]},"delete":{"operationId":"deploy.errors.disconnect","summary":"Disconnect (the project, its key and its managed secret are unchanged)","description":"`deploy:ManageErrorsBinding` Disconnect (the project, its key and its managed secret are unchanged).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageErrorsBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/host-database":{"get":{"operationId":"deploy.host-database.get","summary":"Show a pooled app's pool-host database and its backups, newest first","description":"`deploy:DescribeApp` Show a pooled app's pool-host database and its backups, newest first.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"database":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the database and its role on the host (app_ and 12 hex)"},"state":{"type":"string","enum":["active","dropping","dropped"],"description":"active; dropping once moved or deleted, until the host has dropped it"},"hostState":{"anyOf":[{"type":"string","enum":["provisioning","ready","draining","lost"]},{"type":"null"}],"description":"State of the pool host it lives on; null until the app is placed"},"bytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Size as last reported, in bytes; null if not yet"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last backed up; null if never"},"lastRestoreAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a backup was last restored; null if never"},"backupPending":{"type":"boolean","description":"Whether a backup was asked for and not yet taken"},"restorePending":{"type":"boolean","description":"Whether a restore was asked for and not yet done"},"lastError":{"description":"The host’s last error with it; null if none","type":["string","null"]},"limitMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its size limit in MiB; over it the database is read only"},"overLimit":{"type":"boolean","description":"Whether the pool host found it over its limit and made it read only"},"limitProblem":{"description":"While it is over its limit: what happened and what to do; otherwise null","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"}},"required":["name","state","hostState","bytes","lastBackupAt","lastRestoreAt","backupPending","restorePending","lastError","limitMb","overLimit","limitProblem","createdAt"],"additionalProperties":false},{"type":"null"}],"description":"The app’s pool-host database; null if it has none"},"backups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Backup id, for restore"},"reason":{"type":"string","enum":["daily","manual","before-delete","before-restore","move"],"description":"Why it was taken"},"bytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Size of the dump, in bytes"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was asked for"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was finished"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it is deleted"}},"required":["id","reason","bytes","createdAt","completedAt","expiresAt"],"additionalProperties":false},"description":"Its finished backups, newest first (at most 50)"}},"required":["database","backups"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"deploy.host-database.create","summary":"Give a pooled app a Postgres database on its pool host; the app gets DATABASE_URL at its next start","description":"`deploy:ManageHostDatabase` Give a pooled app a Postgres database on its pool host; the app gets DATABASE_URL at its next start. One Postgres per pool host, a database and role per app, on the host disk. No failover: a lost host is replaced and the database restored from its newest backup. Your own DATABASE_URL (or a managed Postgres binding) wins over this one.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the database and its role on the host"}},"required":["name"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageHostDatabase","x-ews-mutates":true,"x-ews-sensitive":false},"patch":{"operationId":"deploy.host-database.set-limit","summary":"Set the database size limit (MiB); over it the database is read only","description":"`deploy:ManageHostDatabase` Set the database size limit (MiB); over it the database is read only. 1 GiB unless set, 64 MiB to 20 GiB. Over the limit the pool host makes the database read only (writes fail with \"cannot execute … in a read-only transaction\") and get says so in limitProblem; below 90 % of the limit it is writable again.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limitMb":{"type":"integer","minimum":64,"maximum":20480,"description":"The size limit in MiB, 64 (64 MiB) to 20480 (20 GiB); over it the database is read only"}},"required":["limitMb"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"limitMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The size limit now set, in MiB"}},"required":["limitMb"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageHostDatabase","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/host-database/backups":{"post":{"operationId":"deploy.host-database.backup","summary":"Back the database up now (kept 30 days)","description":"`deploy:ManageHostDatabase` Back the database up now (kept 30 days). The pool host takes it within seconds; it appears in get when done.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The request the pool host answers at its next pull"}},"required":["requestId"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageHostDatabase","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/host-database/move":{"post":{"operationId":"deploy.host-database.move","summary":"Move the database to managed Postgres in one step: dump, create the role and database there, restore, bind","description":"`deploy:ManageHostDatabase` Move the database to managed Postgres in one step: dump, create the role and database there, restore, bind. Also needs deploy:ManageDatabaseBinding and rds:ModifyDBInstance on the database (with instanceClass: on all databases, and rds:CreateDBInstance; checked before anything is created). The database must be a publicly accessible Postgres, since a pool host reaches managed Postgres only on its public endpoint; with instanceClass it is created so. It may still be creating: the move waits for it. The app is bound only after the restore succeeded. Writes made between the dump and the switch are not carried over, so move at a quiet time. The pool-host copy is dropped; its dump is kept 30 days.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dbInstanceId":{"description":"An existing managed Postgres database to move to; it may still be creating (the move waits). Give this or instanceClass","type":"string","minLength":3,"maxLength":64},"instanceClass":{"description":"Or create a managed Postgres named <app slug>-db of this instance class (as rds instances create --instance-class), single node, in the app’s region","type":"string","minLength":1,"maxLength":32}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"jobId":{"description":"The move job; null when a move of this app is already queued","type":["string","null"]},"database":{"type":"string","description":"Identifier of the managed Postgres it moves to"}},"required":["jobId","database"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageHostDatabase","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/host-database/restore":{"post":{"operationId":"deploy.host-database.restore","summary":"Replace the database with one of its backups","description":"`deploy:RestoreHostDatabase` Replace the database with one of its backups. The current data is backed up first (reason before-restore, kept 7 days), so a restore can be undone.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"backupId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backup to restore: one of the app’s backups listed by get"}},"required":["backupId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The request the pool host answers at its next pull"}},"required":["requestId"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:RestoreHostDatabase","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/hosting":{"get":{"operationId":"deploy.hosting.get","summary":"Show how a pooled app is served: its URLs, deployments and previews, what is served from files and what needs its server, and whether the server runs","description":"`deploy:DescribeApp` Show how a pooled app is served: its URLs, deployments and previews, what is served from files and what needs its server, and whether the server runs.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"hosting":{"type":"string","const":"machine","description":"The app runs on its own machines"}},"required":["hosting"],"additionalProperties":false},{"type":"object","properties":{"hosting":{"type":"string","const":"pooled","description":"The app runs on pooled hosting"},"url":{"type":"string","description":"The app’s production URL"},"memoryMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Memory reserved for the server while it runs, in MB"},"idleSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds without a request before the server stops"},"dataSavedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the data directory was last saved; null if never"},"dataBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Size of the last saved data, in bytes"},"host":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the shared host"},"state":{"type":"string","enum":["provisioning","ready","draining","lost"],"description":"Its state"},"lastReportAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it last reported; null if never"},"site":{"type":"boolean","description":"Whether it runs on your own hosts"}},"required":["name","state","lastReportAt","site"],"additionalProperties":false},{"type":"null"}],"description":"The shared host the app is placed on; null until placed"},"deployments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"commitSha":{"description":"Commit","type":["string","null"]},"branch":{"description":"Branch it was pushed to","type":["string","null"]},"production":{"type":"boolean","description":"Whether it is the production deployment"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"live or superseded"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"urls":{"type":"array","items":{"type":"string"},"description":"URLs it is served at"},"summary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"instance":{"anyOf":[{"type":"object","properties":{"deployment":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment it serves"},"app":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"App"},"running":{"type":"boolean","description":"Whether the server runs now"},"kind":{"anyOf":[{"type":"string","enum":["restore","boot"]},{"type":"null"}],"description":"How it last started: restored from a snapshot or booted; null if not yet"},"startMs":{"description":"How long the last start took, in ms","type":["number","null"]},"runningSeconds":{"description":"Seconds it has been running; null when stopped","type":["number","null"]},"inflight":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Requests being answered now"},"memoryBytes":{"description":"Memory in use, in bytes; null when stopped","type":["number","null"]},"snapshot":{"type":"boolean","description":"Whether a snapshot to restore from exists"},"snapshotBytes":{"description":"Size of the snapshot, in bytes","type":["number","null"]},"note":{"description":"Anything worth knowing about it; null if nothing","type":["string","null"]},"starts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of boots"},"restores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of restores from a snapshot"}},"required":["deployment","app","running","kind","startMs","runningSeconds","inflight","memoryBytes","snapshot","snapshotBytes","note","starts","restores"],"additionalProperties":false},{"type":"null"}],"description":"Its server on the host; null if none"}},"required":["id","commitSha","branch","production","status","createdAt","urls","summary","instance"],"additionalProperties":false},"description":"Every deployment served now: production and previews"},"requests":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},{"type":"null"}],"description":"Request counters by kind (files, server, redirects, not found, wakes); null if none"}},"required":["hosting","url","memoryMb","idleSeconds","dataSavedAt","dataBytes","host","deployments","requests"],"additionalProperties":false}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/jobs":{"get":{"operationId":"deploy.jobs.list","summary":"List an app’s jobs with their schedule in words, next run and last result","description":"`deploy:DescribeJobs` List an app’s jobs with their schedule in words, next run and last result.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"runnerInstanceId":{"description":"The machine that runs the jobs; null before one has reported in","type":["string","null"]},"jobs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Job id"},"name":{"type":"string","description":"Name, unique in the app"},"schedule":{"type":"string","description":"Cron expression, in UTC"},"scheduleDescription":{"type":"string","description":"The schedule in words, or why it cannot be read"},"command":{"type":"string","description":"Command run with /bin/sh -c"},"service":{"description":"Compose apps: the service it runs in; null: the published service","type":["string","null"]},"timezone":{"type":"string","description":"Time zone of the schedule (UTC)"},"enabled":{"type":"boolean","description":"Whether it runs on its schedule"},"timeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds a run may take before it is stopped"},"concurrency":{"type":"string","enum":["skip","allow"],"description":"skip: a due run is skipped while the previous one runs; allow: it starts anyway"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it runs next; null when disabled"},"lastRun":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id"},"status":{"type":"string","enum":["requested","running","succeeded","failed","timed_out","skipped","lost"],"description":"requested, running, succeeded, failed, timed_out, skipped or lost"},"trigger":{"type":"string","enum":["schedule","manual"],"description":"schedule or manual (run now)"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code; null until it finished"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the run was recorded"}},"required":["id","status","trigger","exitCode","startedAt","finishedAt","createdAt"],"additionalProperties":false},{"type":"null"}],"description":"Its newest run; null if it never ran"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","name","schedule","scheduleDescription","command","service","timezone","enabled","timeoutSec","concurrency","nextRunAt","lastRun","createdAt","updatedAt"],"additionalProperties":false},"description":"The app’s jobs"}},"required":["runnerInstanceId","jobs"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeJobs","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"deploy.jobs.create","summary":"Add a scheduled job to an app","description":"`deploy:CreateJob` Add a scheduled job to an app. schedule is a five-field cron expression in UTC (minute hour day-of-month month day-of-week, or @hourly/@daily/@weekly/@monthly/@yearly). The command runs with /bin/sh -c in the app’s image with its full environment, on one of the app’s machines, which keeps the schedule itself. concurrency \"skip\" (default) records a due run as skipped while the previous one is still going.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$","description":"Name of the job, unique within the app"},"schedule":{"type":"string","minLength":1,"maxLength":200,"description":"When it runs: a five-field cron expression in UTC, or @hourly, @daily, @weekly, @monthly, @yearly"},"command":{"type":"string","minLength":1,"maxLength":4096,"description":"Command run with /bin/sh -c in the app’s image, with the app’s environment"},"service":{"anyOf":[{"type":"string","minLength":1,"maxLength":63,"description":"Compose apps only: the service whose image and environment the job runs with; omitted or null, the published service"},{"type":"null"}]},"enabled":{"type":"boolean","description":"Whether the job runs on its schedule; a new job is enabled unless this is false"},"timeoutSec":{"type":"integer","minimum":10,"maximum":86400,"description":"Seconds a run may take before it is stopped; a new job gets 3600"},"concurrency":{"type":"string","enum":["skip","allow"],"description":"What happens when a run is due while the previous one is still going: skip (a new job’s default) records it as skipped, allow starts it anyway"},"timezone":{"type":"string","const":"UTC","description":"Time zone of the schedule; only UTC"}},"required":["name","schedule","command"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Job id"},"name":{"type":"string","description":"Name, unique in the app"},"schedule":{"type":"string","description":"Cron expression, in UTC"},"scheduleDescription":{"type":"string","description":"The schedule in words, or why it cannot be read"},"command":{"type":"string","description":"Command run with /bin/sh -c"},"service":{"description":"Compose apps: the service it runs in; null: the published service","type":["string","null"]},"timezone":{"type":"string","description":"Time zone of the schedule (UTC)"},"enabled":{"type":"boolean","description":"Whether it runs on its schedule"},"timeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds a run may take before it is stopped"},"concurrency":{"type":"string","enum":["skip","allow"],"description":"skip: a due run is skipped while the previous one runs; allow: it starts anyway"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it runs next; null when disabled"},"lastRun":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id"},"status":{"type":"string","enum":["requested","running","succeeded","failed","timed_out","skipped","lost"],"description":"requested, running, succeeded, failed, timed_out, skipped or lost"},"trigger":{"type":"string","enum":["schedule","manual"],"description":"schedule or manual (run now)"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code; null until it finished"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the run was recorded"}},"required":["id","status","trigger","exitCode","startedAt","finishedAt","createdAt"],"additionalProperties":false},{"type":"null"}],"description":"Its newest run; null if it never ran"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","name","schedule","scheduleDescription","command","service","timezone","enabled","timeoutSec","concurrency","nextRunAt","lastRun","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:CreateJob","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/jobs/{jobId}":{"patch":{"operationId":"deploy.jobs.update","summary":"Change a job, or enable/disable it","description":"`deploy:UpdateJob` Change a job, or enable/disable it. schedule is a five-field cron expression in UTC (minute hour day-of-month month day-of-week, or @hourly/@daily/@weekly/@monthly/@yearly). The command runs with /bin/sh -c in the app’s image with its full environment, on one of the app’s machines, which keeps the schedule itself. Fields left out keep their value.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$","description":"Name of the job, unique within the app"},"schedule":{"type":"string","minLength":1,"maxLength":200,"description":"When it runs: a five-field cron expression in UTC, or @hourly, @daily, @weekly, @monthly, @yearly"},"command":{"type":"string","minLength":1,"maxLength":4096,"description":"Command run with /bin/sh -c in the app’s image, with the app’s environment"},"service":{"anyOf":[{"type":"string","minLength":1,"maxLength":63,"description":"Compose apps only: the service whose image and environment the job runs with; omitted or null, the published service"},{"type":"null"}]},"enabled":{"type":"boolean","description":"Whether the job runs on its schedule; a new job is enabled unless this is false"},"timeoutSec":{"type":"integer","minimum":10,"maximum":86400,"description":"Seconds a run may take before it is stopped; a new job gets 3600"},"concurrency":{"type":"string","enum":["skip","allow"],"description":"What happens when a run is due while the previous one is still going: skip (a new job’s default) records it as skipped, allow starts it anyway"},"timezone":{"type":"string","const":"UTC","description":"Time zone of the schedule; only UTC"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Job id"},"name":{"type":"string","description":"Name, unique in the app"},"schedule":{"type":"string","description":"Cron expression, in UTC"},"scheduleDescription":{"type":"string","description":"The schedule in words, or why it cannot be read"},"command":{"type":"string","description":"Command run with /bin/sh -c"},"service":{"description":"Compose apps: the service it runs in; null: the published service","type":["string","null"]},"timezone":{"type":"string","description":"Time zone of the schedule (UTC)"},"enabled":{"type":"boolean","description":"Whether it runs on its schedule"},"timeoutSec":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds a run may take before it is stopped"},"concurrency":{"type":"string","enum":["skip","allow"],"description":"skip: a due run is skipped while the previous one runs; allow: it starts anyway"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it runs next; null when disabled"},"lastRun":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id"},"status":{"type":"string","enum":["requested","running","succeeded","failed","timed_out","skipped","lost"],"description":"requested, running, succeeded, failed, timed_out, skipped or lost"},"trigger":{"type":"string","enum":["schedule","manual"],"description":"schedule or manual (run now)"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code; null until it finished"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the run was recorded"}},"required":["id","status","trigger","exitCode","startedAt","finishedAt","createdAt"],"additionalProperties":false},{"type":"null"}],"description":"Its newest run; null if it never ran"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","name","schedule","scheduleDescription","command","service","timezone","enabled","timeoutSec","concurrency","nextRunAt","lastRun","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:UpdateJob","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"deploy.jobs.delete","summary":"Remove a job and its run history","description":"`deploy:DeleteJob` Remove a job and its run history.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed job"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeleteJob","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/jobs/{jobId}/runs":{"post":{"operationId":"deploy.jobs.run","summary":"Run a job now, outside its schedule","description":"`deploy:RunJob` Run a job now, outside its schedule. Returns the run with status \"requested\"; the machine starts it within seconds. Read it back with runs.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id"},"status":{"type":"string","enum":["requested","running","succeeded","failed","timed_out","skipped","lost"],"description":"requested, running, succeeded, failed, timed_out, skipped or lost"},"trigger":{"type":"string","enum":["schedule","manual"],"description":"schedule or manual (run now)"},"instanceId":{"description":"The machine that runs it (i-…); null if it was deleted","type":["string","null"]},"scheduledFor":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The minute the schedule said; null for a run now"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it started; null until then"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished; null until then"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code; null until it finished"},"output":{"description":"The last lines it printed (stdout and stderr)","type":["string","null"]},"error":{"description":"Why it ended without an exit code of its own; null otherwise","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the run was recorded"}},"required":["id","status","trigger","instanceId","scheduledFor","startedAt","finishedAt","exitCode","output","error","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:RunJob","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"deploy.jobs.runs","summary":"Read a job’s run history, newest first, with each run’s exit code and output","description":"`deploy:DescribeJobs` Read a job’s run history, newest first, with each run’s exit code and output.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"Most runs to return, newest first; default 50","type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Run id"},"status":{"type":"string","enum":["requested","running","succeeded","failed","timed_out","skipped","lost"],"description":"requested, running, succeeded, failed, timed_out, skipped or lost"},"trigger":{"type":"string","enum":["schedule","manual"],"description":"schedule or manual (run now)"},"instanceId":{"description":"The machine that runs it (i-…); null if it was deleted","type":["string","null"]},"scheduledFor":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The minute the schedule said; null for a run now"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it started; null until then"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished; null until then"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code; null until it finished"},"output":{"description":"The last lines it printed (stdout and stderr)","type":["string","null"]},"error":{"description":"Why it ended without an exit code of its own; null otherwise","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the run was recorded"}},"required":["id","status","trigger","instanceId","scheduledFor","startedAt","finishedAt","exitCode","output","error","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeJobs","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/kafka":{"put":{"operationId":"deploy.kafka.bind","summary":"Bind a managed Kafka cluster as one of its users (private, in the app’s VPC)","description":"`deploy:ManageBrokerBinding` Bind a managed Kafka cluster as one of its users (private, in the app’s VPC). Generates {prefix}KAFKA_BOOTSTRAP_SERVERS (every node:9093), KAFKA_SECURITY_PROTOCOL (SASL_SSL), KAFKA_SASL_MECHANISM (SCRAM-SHA-512), KAFKA_SASL_USERNAME, KAFKA_SASL_PASSWORD (the user’s current password from Secrets) and KAFKA_SSL_CA_LOCATION (the platform CA in the container) at every rollout. Needs secrets:GetSecretValue on the user’s password. A bound user cannot be deleted. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$","description":"The managed Kafka cluster to bind"},"userName":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$","description":"The cluster user the app signs in as (create one with the right grants first)"},"envPrefix":{"description":"Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"redeploy":{"description":"Also roll the live deployment onto the new configuration; default false","type":"boolean"}},"required":["clusterId","userName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"engine":{"type":"string","enum":["kafka","rabbitmq","docdb"],"description":"kafka, rabbitmq or docdb"},"resourceId":{"type":"string","description":"The bound cluster or broker"},"userName":{"type":"string","description":"User the app signs in as"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","engine","resourceId","userName","envPrefix","generatedKeys"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:GetSecretValue","deploy:DeployApp"]},"delete":{"operationId":"deploy.kafka.unbind","summary":"Remove the binding (the cluster and its user are unchanged)","description":"`deploy:ManageBrokerBinding` Remove the binding (the cluster and its user are unchanged).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"envPrefix","in":"query","required":false,"schema":{"description":"Which binding to remove, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/rabbitmq":{"put":{"operationId":"deploy.rabbitmq.bind","summary":"Bind a managed RabbitMQ broker as one of its users (private, in the app’s VPC)","description":"`deploy:ManageBrokerBinding` Bind a managed RabbitMQ broker as one of its users (private, in the app’s VPC). Generates {prefix}AMQP_URL (amqps://user:password@<broker address>:5671/%2F — the balancer with 3 nodes), AMQP_HOSTS (every node:5671, for clients that take a list), AMQP_USERNAME, AMQP_PASSWORD and AMQP_CA_FILE (the platform CA in the container) at every rollout. Needs secrets:GetSecretValue on the user’s password. A bound user cannot be deleted. Saving does not restart the app. Pass redeploy: true to roll the live deployment’s own source onto the new configuration (also needs deploy:DeployApp); otherwise the response and GET …/env report pending until someone redeploys.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brokerId":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$","description":"The managed RabbitMQ broker to bind"},"userName":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$","description":"The broker user the app signs in as"},"envPrefix":{"description":"Put in front of every generated variable name (e.g. CACHE_ gives CACHE_REDIS_URL), so one app can hold several bindings of a kind; default empty","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"},"redeploy":{"description":"Also roll the live deployment onto the new configuration; default false","type":"boolean"}},"required":["brokerId","userName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Binding id"},"engine":{"type":"string","enum":["kafka","rabbitmq","docdb"],"description":"kafka, rabbitmq or docdb"},"resourceId":{"type":"string","description":"The bound cluster or broker"},"userName":{"type":"string","description":"User the app signs in as"},"envPrefix":{"type":"string","description":"Prefix of the generated variable names; empty for none"},"generatedKeys":{"type":"array","items":{"type":"string"},"description":"Variable names the binding generates"}},"required":["id","engine","resourceId","userName","envPrefix","generatedKeys"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:GetSecretValue","deploy:DeployApp"]},"delete":{"operationId":"deploy.rabbitmq.unbind","summary":"Remove the binding (the broker and its user are unchanged)","description":"`deploy:ManageBrokerBinding` Remove the binding (the broker and its user are unchanged).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"envPrefix","in":"query","required":false,"schema":{"description":"Which binding to remove, by its envPrefix; default empty (the unprefixed one)","type":"string","maxLength":32,"pattern":"^([A-Z][A-Z0-9_]*_)?$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The removed binding"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:ManageBrokerBinding","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/redeploy":{"post":{"operationId":"deploy.redeploy.apply","summary":"Redeploy the live deployment’s source with the current configuration (no rebuild)","description":"`deploy:DeployApp` Redeploy the live deployment’s source with the current configuration (no rebuild).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"Why, shown on the deployment; default \"configuration applied by <user>\"","type":"string","maxLength":200}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"ok":{"type":"boolean","const":true,"description":"The deployment was started"},"deploymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The deployment started"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its generation"},"reusedDeploymentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The deployment whose source it runs again; null if none"}},"required":["ok","deploymentId","generation","reusedDeploymentId"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeployApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/registry-credentials":{"get":{"operationId":"deploy.registry-credentials.list","summary":"List the registry credentials of an app (never the password)","description":"`deploy:DescribeApp` List the registry credentials of an app (never the password).","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Credential id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"registryHost":{"type":"string","description":"Registry host, e.g. ghcr.io"},"username":{"type":"string","description":"User name the machine signs in with"},"passwordSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret holding the password; null if it was deleted"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","registryHost","username","passwordSecretId","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"deploy.registry-credentials.replace","summary":"Replace the registry credentials of an app","description":"`deploy:UpdateApp` Replace the registry credentials of an app. The password is the id of a Deutsche Cloud Secret. Binding needs secrets:GetSecretValue on it and grants it to the deploy consumer.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"registryHost":{"type":"string","minLength":1,"maxLength":253},"username":{"type":"string","minLength":1,"maxLength":256},"passwordSecretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["registryHost","username","passwordSecretId"]},"description":"The complete set, one per registry: registryHost, username and passwordSecretId (the Secret holding the password or token). Registries left out lose their credential; an empty list removes all"}},"required":["credentials"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Credential id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app"},"registryHost":{"type":"string","description":"Registry host, e.g. ghcr.io"},"username":{"type":"string","description":"User name the machine signs in with"},"passwordSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret holding the password; null if it was deleted"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was added"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was last changed"}},"required":["id","appId","registryHost","username","passwordSecretId","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:UpdateApp","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:GetSecretValue"]}},"/deploy/api/apps/{id}/resources":{"get":{"operationId":"deploy.apps.resources","summary":"Show the app as a tree: deployment, load balancer, machines, containers, names and bound data, each with health and sync","description":"`deploy:DescribeApp` Show the app as a tree: deployment, load balancer, machines, containers, names and bound data, each with health and sync. Bound databases, caches and brokers appear only for a caller who may describe that service. Health is one of healthy, progressing, degraded, suspended, missing, unknown; sync is in_sync, out_of_sync or unknown.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"health":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","progressing","degraded","suspended","missing","unknown"],"description":"Health"},"reason":{"type":"string","description":"Why"}},"required":["health","reason"],"additionalProperties":false,"description":"Health of the whole app"},"nodes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Unique key, e.g. machine:i-abc or container:i-abc:web"},"parent":{"description":"Key of the parent node; null for the root","type":["string","null"]},"kind":{"type":"string","enum":["app","deployment","load-balancer","machine","container","domain","database","cache","broker"],"description":"What the node is"},"service":{"type":"string","description":"Service it belongs to"},"name":{"type":"string","description":"Name"},"detail":{"description":"One line: image, size, address or engine","type":["string","null"]},"href":{"description":"Console path of its own page; null if none","type":["string","null"]},"health":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","progressing","degraded","suspended","missing","unknown"],"description":"Health"},"reason":{"type":"string","description":"Why"}},"required":["health","reason"],"additionalProperties":false,"description":"Health and why"},"sync":{"anyOf":[{"type":"object","properties":{"sync":{"type":"string","enum":["in_sync","out_of_sync","unknown"],"description":"Whether it runs what it should"},"reason":{"type":"string","description":"Why"},"rollingOut":{"type":"boolean","description":"Out of sync only because a rollout is in progress"}},"required":["sync","reason","rollingOut"],"additionalProperties":false},{"type":"null"}],"description":"Sync of a machine or container; null for other nodes"},"reportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it last reported; null if never or not applicable"},"events":{"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","description":"Kind of resource the events are about"},"resourceId":{"type":"string","description":"Its id"}},"required":["resourceType","resourceId"],"additionalProperties":false},"description":"Where its events are read from (resource-activity reads them)"},"logStream":{"description":"Log stream prefix of a container; null otherwise","type":["string","null"]}},"required":["key","parent","kind","service","name","detail","href","health","sync","reportedAt","events","logStream"],"additionalProperties":false},"description":"Every node, flat; parent links them into a tree"}},"required":["health","nodes"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/resources/activity":{"get":{"operationId":"deploy.apps.resource-activity","summary":"Read one node's last events and, for a container, its last log lines","description":"`deploy:DescribeApp` Read one node's last events and, for a container, its last log lines. node is a key from the resources tree, e.g. machine:i-abc or container:i-abc:web. Log lines need monitoring:FilterLogEvents.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"node","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":300,"description":"Key of a node from the resources tree, e.g. machine:i-abc or container:i-abc:web"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"node":{"type":"object","properties":{"key":{"type":"string","description":"Unique key, e.g. machine:i-abc or container:i-abc:web"},"parent":{"description":"Key of the parent node; null for the root","type":["string","null"]},"kind":{"type":"string","enum":["app","deployment","load-balancer","machine","container","domain","database","cache","broker"],"description":"What the node is"},"service":{"type":"string","description":"Service it belongs to"},"name":{"type":"string","description":"Name"},"detail":{"description":"One line: image, size, address or engine","type":["string","null"]},"href":{"description":"Console path of its own page; null if none","type":["string","null"]},"health":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","progressing","degraded","suspended","missing","unknown"],"description":"Health"},"reason":{"type":"string","description":"Why"}},"required":["health","reason"],"additionalProperties":false,"description":"Health and why"},"sync":{"anyOf":[{"type":"object","properties":{"sync":{"type":"string","enum":["in_sync","out_of_sync","unknown"],"description":"Whether it runs what it should"},"reason":{"type":"string","description":"Why"},"rollingOut":{"type":"boolean","description":"Out of sync only because a rollout is in progress"}},"required":["sync","reason","rollingOut"],"additionalProperties":false},{"type":"null"}],"description":"Sync of a machine or container; null for other nodes"},"reportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it last reported; null if never or not applicable"},"events":{"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","description":"Kind of resource the events are about"},"resourceId":{"type":"string","description":"Its id"}},"required":["resourceType","resourceId"],"additionalProperties":false},"description":"Where its events are read from (resource-activity reads them)"},"logStream":{"description":"Log stream prefix of a container; null otherwise","type":["string","null"]}},"required":["key","parent","kind","service","name","detail","href","health","sync","reportedAt","events","logStream"],"additionalProperties":false,"description":"The node, as the resources tree has it"},"events":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"},"level":{"type":"string","enum":["info","warn","error"],"description":"info, warn or error"},"phase":{"description":"Stage; null if none","type":["string","null"]},"source":{"type":"string","enum":["control_plane","machine"],"description":"control_plane or machine"},"message":{"type":"string","description":"What happened"}},"required":["at","level","phase","source","message"],"additionalProperties":false},"description":"Its last 20 events, oldest first"},"logs":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the line was written"},"stream":{"type":"string","description":"Log stream"},"message":{"type":"string","description":"The line"}},"required":["at","stream","message"],"additionalProperties":false}},{"type":"null"}],"description":"A container’s last 100 log lines, oldest first; null otherwise"},"logsUnavailable":{"description":"Why logs is null for a container; null otherwise","type":["string","null"]}},"required":["node","events","logs","logsUnavailable"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/resources/diff":{"get":{"operationId":"deploy.apps.live-diff","summary":"Compare what one machine runs with what it was asked to run","description":"`deploy:DescribeApp` Compare what one machine runs with what it was asked to run. state is match, differs or unknown (the machine has not sent a summary yet). Containers, images, states, published ports, routes and the health check are compared; environment keys only for a caller with deploy:ManageEnv, by keyed hash. Values never leave the machine.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"instance","in":"query","required":true,"schema":{"type":"string","pattern":"^i-[a-z0-9]{1,40}$","description":"The machine to compare, by its id as the resources tree names it (i-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"state":{"type":"string","const":"unknown","description":"The machine has not sent a summary yet"},"reason":{"type":"string","description":"Why, in one sentence"},"items":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Where: a container name, routes, health check"},"message":{"type":"string","description":"The difference, in one sentence"},"severity":{"type":"string","enum":["differs","missing","extra"],"description":"differs, missing or extra"}},"required":["scope","message","severity"],"additionalProperties":false},"description":"Always empty"},"checkedAt":{"type":"null","description":"Always null"}},"required":["state","reason","items","checkedAt"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","enum":["match","differs"],"description":"Whether the machine runs what it should"},"reason":{"type":"string","description":"Summary in one sentence"},"items":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Where: a container name, routes, health check"},"message":{"type":"string","description":"The difference, in one sentence"},"severity":{"type":"string","enum":["differs","missing","extra"],"description":"differs, missing or extra"}},"required":["scope","message","severity"],"additionalProperties":false},"description":"Each difference"},"checkedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the machine took its summary"},"envCompared":{"type":"boolean","description":"Whether environment keys were compared (only with deploy:ManageEnv)"}},"required":["state","reason","items","checkedAt","envCompared"],"additionalProperties":false}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/apps/{id}/routing":{"get":{"operationId":"deploy.apps.routing","summary":"Show how each hostname of the app resolves right now","description":"`deploy:DescribeApp` Show how each hostname of the app resolves right now.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"Hostname"},"url":{"type":"string","description":"URL the app answers at"},"kind":{"type":"string","enum":["default","custom"],"description":"default: the platform name; custom: a domain"},"wildcard":{"type":"boolean","description":"A *.host domain covering every name one label below"},"domainId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The custom domain’s id; null for the default host"},"isPrimary":{"type":"boolean","description":"Whether it is the primary domain"},"platformManaged":{"type":"boolean","description":"True when the platform nameservers answer for it with no action from you"},"hostedZone":{"anyOf":[{"type":"object","properties":{"zoneId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Hosted zone id"},"zoneName":{"type":"string","description":"Zone name"},"answersForApp":{"type":"boolean","description":"Whether the zone holds a record pointing at the app"},"delegation":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["delegated","elsewhere","pending"],"description":"Delegation state"},"detail":{"type":"string","description":"One sentence about it"},"checkedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it was last checked; null if never"}},"required":["status","detail","checkedAt"],"additionalProperties":false},{"type":"null"}],"description":"Whether the zone is delegated; null when you may not read the zone"}},"required":["zoneId","zoneName","answersForApp","delegation"],"additionalProperties":false},{"type":"null"}],"description":"Your hosted zone that answers for the name; null outside every zone"},"requiredRecord":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["A","CNAME","ALIAS"],"description":"Record type"},"name":{"type":"string","description":"Record name"},"value":{"type":"string","description":"Record value"},"note":{"type":"string","description":"Why this record"}},"required":["type","name","value","note"],"additionalProperties":false},{"type":"null"}],"description":"The DNS record to create; null when the platform answers for the name"},"dns":{"type":"object","properties":{"state":{"type":"string","enum":["ok","mismatch","missing","unknown"],"description":"What DNS answers now"},"observed":{"type":"array","items":{"type":"string"},"description":"Addresses or CNAME targets DNS returned"},"expectedIp":{"description":"Address the name should resolve to; null before the first deployment","type":["string","null"]},"detail":{"type":"string","description":"One sentence about it"}},"required":["state","observed","expectedIp","detail"],"additionalProperties":false,"description":"DNS, resolved live"},"tls":{"type":"object","properties":{"state":{"type":"string","enum":["active","pending","failed","unavailable","on-demand"],"description":"Certificate state; on-demand for a wildcard, one per name on first request"},"detail":{"type":"string","description":"Why, in one sentence"},"reportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the machine last reported on it; null if never"}},"required":["state","detail","reportedAt"],"additionalProperties":false,"description":"The certificate"}},"required":["host","url","kind","wildcard","domainId","isPrimary","platformManaged","hostedZone","requiredRecord","dns","tls"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/deployments/{id}":{"get":{"operationId":"deploy.deployments.get","summary":"Describe one deployment","description":"`deploy:DescribeApp` Describe one deployment.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"},"terminal":{"type":"boolean","description":"Whether it is live, failed or superseded"},"succeeded":{"type":"boolean","description":"Whether it is live"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt","terminal","succeeded"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/deployments/{id}/build-log":{"get":{"operationId":"deploy.deployments.build-log","summary":"Read the log of a deployment's image build, line by line","description":"`deploy:GetBuildLogs` Read the log of a deployment's image build, line by line. Lines as the builder printed them (colours stripped, URL credentials masked), kept with the deployment. Pass the previous answer's `next` as `after` to tail it while it runs; `done` is true once the builder reported its `exitCode` or the build step is over.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"after","in":"query","required":false,"schema":{"description":"The previous answer’s next: only lines after this byte offset; omitted, from the start","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"description":"Most lines to return; default 2000","type":"integer","minimum":1,"maximum":5000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"object","properties":{"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Byte offset where the line starts"},"ts":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was printed"},"line":{"type":"string","description":"The line"}},"required":["offset","ts","line"],"additionalProperties":false},"description":"Lines after `after`, in order"},"next":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Offset to pass as after next time; null before any line"},"exitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The builder’s exit code; null until it finished"},"done":{"type":"boolean","description":"True once no more lines will come"}},"required":["lines","next","exitCode","done"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:GetBuildLogs","x-ews-mutates":false,"x-ews-sensitive":true}},"/deploy/api/deployments/{id}/cancel":{"post":{"operationId":"deploy.deployments.cancel","summary":"Stop a deployment that has not finished","description":"`deploy:DeployApp` Stop a deployment that has not finished. Only a queued, building, pushing or deploying deployment can be cancelled (409 otherwise). The pipeline stops at the end of its current step.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DeployApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/deploy/api/deployments/{id}/events":{"get":{"operationId":"deploy.deployments.events","summary":"Read the activity feed of a deployment, including release output","description":"`deploy:DescribeApp` Read the activity feed of a deployment, including release output.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"since","in":"query","required":false,"schema":{"description":"Only events created after this time (ISO 8601), to follow the feed","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Event id"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization"},"resourceType":{"type":"string","description":"Kind of resource, deployment here"},"resourceId":{"type":"string","description":"The deployment’s id"},"source":{"type":"string","enum":["control_plane","machine"],"description":"control_plane or machine"},"level":{"type":"string","enum":["info","warn","error"],"description":"info, warn or error"},"phase":{"description":"Stage, e.g. build or release; null if none","type":["string","null"]},"message":{"type":"string","description":"What happened"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["id","orgId","resourceType","resourceId","source","level","phase","message","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/deploy/api/deployments/{id}/wait":{"get":{"operationId":"deploy.deployments.wait","summary":"Wait until a deployment is live, failed or superseded","description":"`deploy:DescribeApp` Wait until a deployment is live, failed or superseded. Long-poll: returns at a terminal status or after timeoutSec (max 55) with terminal=false. Call it again until terminal. A failed deployment carries its error events.","tags":["Apps"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"timeoutSec","in":"query","required":false,"schema":{"description":"Seconds to wait at most before answering with terminal false; default 55","type":"integer","minimum":1,"maximum":55}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deployment id"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The app deployed"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Organization the deployment belongs to"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The app generation this deployment represents"},"trigger":{"type":"string","enum":["push","manual","rollback"],"description":"What started it"},"gitCommitSha":{"description":"Commit built; null for an image or compose app","type":["string","null"]},"imageRef":{"description":"Image run, by digest once built; null for a compose deployment","type":["string","null"]},"composeDigest":{"description":"sha256 of the compose file pinned to it; null for other builders","type":["string","null"]},"composeImagePins":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Compose: service name → image digest, for images whose signature was checked; null: none"},"envSnapshot":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Variable name"},"valueKind":{"type":"string","enum":["plain","secret"],"description":"plain or secret"},"plainValue":{"description":"The value of a plain variable; null for a secret","type":["string","null"]},"kmsSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Secret bound, for a secret; null for plain"}},"required":["key","valueKind","plainValue","kmsSecretId"],"additionalProperties":false}},{"type":"null"}],"description":"The environment when it started (secrets by reference), what a rollback restores; null on older deployments and for a caller without deploy:ManageEnv"},"status":{"type":"string","enum":["queued","building","pushing","deploying","live","failed","superseded"],"description":"queued, building, pushing, deploying, live, failed or superseded"},"releaseCommand":{"description":"Release command pinned when it started; null: none","type":["string","null"]},"releaseStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"],"description":"Where the release command stands; skipped when there is none"},"releaseExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code of the release command; null until it ran"},"buildLogRef":{"description":"Unused; always null","type":["string","null"]},"buildExitCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Exit code the builder reported; null until it finished"},"errorMessage":{"description":"Why it failed; null unless failed","type":["string","null"]},"createdBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"IAM user who started it; null for a push or the platform"},"reason":{"description":"Why it was started, as the starter said; null: none","type":["string","null"]},"statusHistory":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Status entered"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"}},"required":["status","at"],"additionalProperties":false},"description":"Every status it passed through, oldest first"},"bundleKey":{"description":"Pooled hosting: storage key of the uploaded bundle; null otherwise","type":["string","null"]},"bundleSha256":{"description":"Pooled hosting: sha256 of the bundle","type":["string","null"]},"bundleBytes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pooled hosting: size of the bundle, in bytes"},"branch":{"description":"Pooled hosting: branch the commit was pushed to","type":["string","null"]},"preview":{"type":"boolean","description":"Pooled hosting: a preview at its own URL rather than production"},"hostingSummary":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["static","hybrid","fallback"],"description":"static: files only; hybrid: some routes need the server; fallback: all do"},"nextVersion":{"description":"Next.js version of the build; null if unknown","type":["string","null"]},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of files served without the server"},"nodeRoutes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Route"},"reason":{"type":"string","description":"Why it needs the server"}},"required":["path","reason"],"additionalProperties":false},"description":"Routes the app’s server answers"}},"required":["kind","nextVersion","files","nodeRoutes"],"additionalProperties":false},{"type":"null"}],"description":"Pooled hosting: what the bundle contains; null until read"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was started"},"liveAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it went live; null if it never did"},"terminal":{"type":"boolean","description":"Whether it is live, failed or superseded"},"succeeded":{"type":"boolean","description":"Whether it is live"},"errors":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When"},"phase":{"description":"Stage; null if none","type":["string","null"]},"message":{"type":"string","description":"What went wrong"}},"required":["at","phase","message"],"additionalProperties":false},"description":"For a failed deployment its last 20 error events; otherwise empty"}},"required":["id","appId","orgId","generation","trigger","gitCommitSha","imageRef","composeDigest","composeImagePins","envSnapshot","status","releaseCommand","releaseStatus","releaseExitCode","buildLogRef","buildExitCode","errorMessage","createdBy","reason","statusHistory","bundleKey","bundleSha256","bundleBytes","branch","preview","hostingSummary","createdAt","liveAt","terminal","succeeded","errors"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones":{"get":{"operationId":"dns.zones.list","summary":"List hosted zones and the platform nameservers","description":"`dns:ListZones` List hosted zones and the platform nameservers.","tags":["DNS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ListZones","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"dns.zones.create","summary":"Create a hosted zone for a domain you own","description":"`dns:CreateZone` Create a hosted zone for a domain you own. One owner per domain platform-wide, and the platform root domain cannot be hosted. Delegate by setting the returned nameservers as the NS records at the registrar.","tags":["DNS"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":253,"description":"The domain, such as example.com: trimmed, lowercased, trailing dot dropped, at most 253 characters. Refused (400) when it is not a hostname or is, sits under or encloses the platform domain; refused (409) when another organization holds it or an overlapping name as a zone or app domain, or when it lies inside an existing hosted zone"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:CreateZone","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}":{"get":{"operationId":"dns.zones.get","summary":"Describe a hosted zone and its delegation state","description":"`dns:GetZone` Describe a hosted zone and its delegation state.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:GetZone","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"dns.zones.delete","summary":"Delete a hosted zone and every record in it","description":"`dns:DeleteZone` Delete a hosted zone and every record in it.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:DeleteZone","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/check-delegation":{"post":{"operationId":"dns.zones.check-delegation","summary":"Ask public resolvers which nameservers the domain delegates to","description":"`dns:CheckDelegation` Ask public resolvers which nameservers the domain delegates to. Records the result on the zone; a read that stores what it saw.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:CheckDelegation","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec":{"get":{"operationId":"dns.dnssec.get","summary":"A zone's DNSSEC status, keys, the DS to put at the registrar and the parent's DS","description":"`dns:GetDnssec` A zone's DNSSEC status, keys, the DS to put at the registrar and the parent's DS.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:GetDnssec","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec/check":{"post":{"operationId":"dns.dnssec.check","summary":"Ask public resolvers which DS records the parent zone serves","description":"`dns:GetDnssec` Ask public resolvers which DS records the parent zone serves. Records the result on the zone; a read that stores what it saw.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:GetDnssec","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec/complete-rollover":{"post":{"operationId":"dns.dnssec.complete-rollover","summary":"Finish a key-signing key rollover now, removing the old key","description":"`dns:CompleteDnssecKeyRollover` Finish a key-signing key rollover now, removing the old key. Only once the registrar has the new DS: a parent still pointing at the old key makes the zone fail validation.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:CompleteDnssecKeyRollover","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec/disable":{"post":{"operationId":"dns.dnssec.disable","summary":"Stop signing once the parent no longer serves the DS, or at once","description":"`dns:DisableDnssec` Stop signing once the parent no longer serves the DS, or at once. Remove the DS at the registrar first. Without immediately the zone stays signed until public resolvers stop returning the DS, then about an hour more.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"immediately":{"description":"Stop signing now instead of once the parent no longer serves the DS","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:DisableDnssec","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec/enable":{"post":{"operationId":"dns.dnssec.enable","summary":"Sign the zone (ECDSA P-256); returns the DS record for the registrar","description":"`dns:EnableDnssec` Sign the zone (ECDSA P-256); returns the DS record for the registrar. The zone is signed within one nameserver pull. Validation starts once the DS is at the registrar.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:EnableDnssec","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/dnssec/rotate":{"post":{"operationId":"dns.dnssec.rotate","summary":"Start a rollover of the key-signing (ksk) or zone-signing (zsk) key","description":"`dns:RotateDnssecKey` Start a rollover of the key-signing (ksk) or zone-signing (zsk) key. zsk: a new key is published and signs after two hours (ZSKs also roll every 90 days by themselves). ksk: a second key signs the DNSKEY set at once; replace the DS at the registrar, and the old key goes when public resolvers serve only the new DS.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","enum":["ksk","zsk"],"description":"ksk: key-signing key; zsk: zone-signing key"}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:RotateDnssecKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/export":{"get":{"operationId":"dns.zones.export","summary":"The zone as a master file","description":"`dns:ListRecords` The zone as a master file.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ListRecords","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones/{id}/import":{"post":{"operationId":"dns.zones.import","summary":"Add records from a zone file, replacing sets with the same name and type","description":"`dns:ImportZone` Add records from a zone file, replacing sets with the same name and type. SOA and apex NS lines are skipped. Any invalid line fails the whole import.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"zoneFile":{"type":"string","minLength":1,"maxLength":1000000,"description":"RFC 1035 master-file text, 1 to 1,000,000 characters. $ORIGIN and $TTL are honoured (TTL 300 until a $TTL line); other $ directives, SOA and apex NS lines are skipped and reported"}},"required":["zoneFile"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ImportZone","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/query-log":{"get":{"operationId":"dns.query-log.get","summary":"The queries the nameservers answered for the zone, newest first","description":"`dns:GetQueryLog` The queries the nameservers answered for the zone, newest first. One line per query: name, type, rcode, answer count, transport, client network (/24 or /56), DO and ECS flags. Kept seven days. Query counts per zone and rcode are the EWS/DNS Queries metric in monitoring, whether logging is on or not.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"minutes","in":"query","required":false,"schema":{"description":"How far back, in minutes: 1 to 10080 (the seven days the log keeps), default 60","type":"integer","minimum":1,"maximum":10080}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many lines, newest first: 1 to 1000, default 200","type":"integer","minimum":1,"maximum":1000}},{"name":"contains","in":"query","required":false,"schema":{"description":"Only lines containing this text (a name, a type, an rcode, a client network), at most 253 characters","type":"string","maxLength":253}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:GetQueryLog","x-ews-mutates":false,"x-ews-sensitive":false}},"/dns/api/zones/{id}/query-logging":{"put":{"operationId":"dns.query-log.set","summary":"Turn query logging on or off","description":"`dns:UpdateQueryLogging` Turn query logging on or off. Takes effect within one nameserver pull; lines arrive about a minute later.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Log every answered query of the zone"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:UpdateQueryLogging","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/records":{"get":{"operationId":"dns.records.list","summary":"List the record sets of a zone","description":"`dns:ListRecords` List the record sets of a zone.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ListRecords","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"dns.records.set","summary":"Create or replace the record set at a name and type","description":"`dns:ChangeRecords` Create or replace the record set at a name and type. name is \"@\", a relative label such as \"www\", or a fully qualified name in the zone. ALIAS takes exactly one of appId, loadBalancerId, bucket or distributionId instead of values, and works at the apex. A, AAAA and CNAME may name an uptime check (healthCheckId) and failoverValues answered while it is down; their TTL is then served as at most 60 seconds.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":253,"description":"Where the set sits: \"@\" or empty for the apex, a relative label such as \"www\", or a fully qualified name inside the zone. Refused (400) outside the zone, for NS or CNAME at the apex, for a CNAME next to other records, and for another type at a name that has a CNAME"},"type":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","NS","SRV","CAA","ALIAS"],"description":"Record type. ALIAS is the platform type that answers with the address of an app, load balancer, bucket website or CDN distribution. Writing a set replaces the one at the same name and type"},"ttl":{"description":"Seconds resolvers may cache the set, 1 to 604800. Absent: 300 in the API (the console form starts at 3600). A set with a health check or routed variant checks is served with at most 60","type":"integer","minimum":1,"maximum":604800},"values":{"description":"The record data in presentation format, one entry per value, at most 100 of at most 4096 characters each: A \"203.0.113.7\", MX \"10 mail.example.com\", SRV \"10 5 5060 sip.example.com\", CAA \"0 issue letsencrypt.org\", TXT the text. Duplicates are merged. A CNAME takes exactly one. Required (400 \"At least one value is required\") unless the type is ALIAS or routing supplies them, when a routed set takes the first variant's values","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"appId":{"description":"ALIAS: the app whose address is answered","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"loadBalancerId":{"description":"ALIAS: a load balancer, answered with its IPv4 (A) and IPv6 (AAAA)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bucket":{"description":"ALIAS: a bucket name; the name answers with the bucket's static website","type":"string"},"distributionId":{"description":"ALIAS: a CDN distribution, answered with its healthy edge nodes (TTL at most 30 s); list the name among the distribution's aliases too, for its certificate","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"healthCheckId":{"description":"A, AAAA, CNAME: an uptime check; null removes it","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"failoverValues":{"description":"Answered instead of values while the health check is down","type":"array","items":{"type":"string"}},"routing":{"description":"Weighted ({policy:\"weighted\", variants:[{id, weight 0-255, values, healthCheckId?}]}) or geolocation ({policy:\"geo\", variants:[{id, country|continent, values, healthCheckId?}]}) routing; null removes it. For geo, values are the default answer.","anyOf":[{"oneOf":[{"type":"object","properties":{"policy":{"type":"string","const":"weighted"},"variants":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"healthCheckId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"weight":{"type":"integer","minimum":0,"maximum":255}},"required":["id","values","weight"]}}},"required":["policy","variants"]},{"type":"object","properties":{"policy":{"type":"string","const":"geo"},"variants":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"healthCheckId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"country":{"type":"string","pattern":"^[A-Za-z]{2}$"},"continent":{"type":"string","enum":["AF","AN","AS","EU","NA","OC","SA"]}},"required":["id","values"]}}},"required":["policy","variants"]}]},{"type":"null"}]}},"required":["name","type"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ChangeRecords","x-ews-mutates":true,"x-ews-sensitive":false}},"/dns/api/zones/{id}/records/{recordId}":{"put":{"operationId":"dns.records.update","summary":"Change the values or TTL of a record set","description":"`dns:ChangeRecords` Change the values or TTL of a record set. Fields left out keep their stored value. An ALIAS target sent here replaces the old one; healthCheckId null removes the check, but stored failoverValues must be cleared in the same call (failoverValues: []) or the change is refused.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ttl":{"description":"Seconds resolvers may cache the set, 1 to 604800. Absent: the TTL is kept","type":"integer","minimum":1,"maximum":604800},"values":{"description":"Replaces the values (at most 100 of at most 4096 characters each; a CNAME takes one). Absent: the values are kept. The name and type of a set cannot change","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"appId":{"description":"ALIAS: the app whose address is answered","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"loadBalancerId":{"description":"ALIAS: a load balancer, answered with its IPv4 (A) and IPv6 (AAAA)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bucket":{"description":"ALIAS: a bucket name; the name answers with the bucket's static website","type":"string"},"distributionId":{"description":"ALIAS: a CDN distribution, answered with its healthy edge nodes (TTL at most 30 s); list the name among the distribution's aliases too, for its certificate","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"healthCheckId":{"description":"A, AAAA, CNAME: an uptime check; null removes it","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"failoverValues":{"description":"Answered instead of values while the health check is down","type":"array","items":{"type":"string"}},"routing":{"description":"Weighted ({policy:\"weighted\", variants:[{id, weight 0-255, values, healthCheckId?}]}) or geolocation ({policy:\"geo\", variants:[{id, country|continent, values, healthCheckId?}]}) routing; null removes it. For geo, values are the default answer.","anyOf":[{"oneOf":[{"type":"object","properties":{"policy":{"type":"string","const":"weighted"},"variants":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"healthCheckId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"weight":{"type":"integer","minimum":0,"maximum":255}},"required":["id","values","weight"]}}},"required":["policy","variants"]},{"type":"object","properties":{"policy":{"type":"string","const":"geo"},"variants":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"values":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":4096}},"healthCheckId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"country":{"type":"string","pattern":"^[A-Za-z]{2}$"},"continent":{"type":"string","enum":["AF","AN","AS","EU","NA","OC","SA"]}},"required":["id","values"]}}},"required":["policy","variants"]}]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ChangeRecords","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"dns.records.delete","summary":"Delete a record set","description":"`dns:ChangeRecords` Delete a record set.","tags":["DNS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"dns:ChangeRecords","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/ca-bundle":{"get":{"operationId":"docdb.clusters.ca-bundle","summary":"The platform CA (PEM) for `tlsCAFile`","description":"`docdb:DescribeDocdbClusters` The platform CA (PEM) for `tlsCAFile`.","tags":["Document Database"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/docdb/api/clusters":{"get":{"operationId":"docdb.clusters.list","summary":"List Document Database clusters","description":"`docdb:DescribeDocdbClusters` List Document Database clusters.","tags":["Document Database"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"docdb.clusters.create","summary":"Create a Document Database cluster","description":"`docdb:CreateDocdbCluster` Create a Document Database cluster. `creating` until FerretDB answers on 27017 (TLS only), usually 4–8 minutes. The master password is filed in Secrets as DOCDB_<IDENTIFIER>_PASSWORD. Every user, including ones made with `createUser`, has full access to every database (roles are not enforced by FerretDB 2.7). No SQL access: only the MongoDB port is open. Not supported: multi-document transactions (refused with error 115 by the wire guard on clusters made since 2026-11-17; older clusters keep the writes inside one even after an abort) and change streams.","tags":["Document Database"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from server-types, e.g. performance-2. The provider’s own type names are still accepted, deprecated."},"nodes":{"default":1,"description":"1: one machine. 3: Postgres with Patroni across zones behind a balancer, automatic failover (8 GiB per node at least)","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"masterUsername":{"default":"docdb_admin","description":"The user the cluster is created with; its password is filed in Secrets","type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z][a-z0-9_]*$"},"volumeSizeGib":{"default":20,"type":"integer","minimum":10,"maximum":4000},"publiclyAccessible":{"default":false,"description":"Reachable from the internet on 27017 (TLS and a password still required)","type":"boolean"},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"backupRetentionDays":{"default":7,"type":"integer","minimum":0,"maximum":35},"deletionProtection":{"default":false,"type":"boolean"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["identifier","nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:CreateDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}":{"get":{"operationId":"docdb.clusters.get","summary":"One cluster: status, endpoint, versions (Postgres, FerretDB, DocumentDB) and the connection string template","description":"`docdb:DescribeDocdbClusters` One cluster: status, endpoint, versions (Postgres, FerretDB, DocumentDB) and the connection string template.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"docdb.clusters.delete","summary":"Delete a cluster, its machines, volumes and balancer","description":"`docdb:DeleteDocdbCluster` Delete a cluster, its machines, volumes and balancer. Refused with 400 while deletion protection is on. With finalBackup=true a full backup is taken first; if it fails nothing is deleted. The cluster then stays as `retained` (no machines; its backups, the ones taken by hand included, and its master password kept) until its retention period ends, and can be restored from. Without it every backup goes with the cluster. Deleting a `retained` cluster removes its backups at once.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"finalBackup","in":"query","required":false,"schema":{"description":"true: take a full backup first and keep the backups for the retention period, as a `retained` cluster that can be restored from","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DeleteDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/backup-settings":{"patch":{"operationId":"docdb.clusters.modify-backup-settings","summary":"Change backup retention or the daily backup window","description":"`docdb:ModifyDocdbCluster` Change backup retention or the daily backup window.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"backupRetentionDays":{"type":"integer","minimum":0,"maximum":35},"backupWindow":{"description":"HH:MM-HH:MM in UTC; only the start is used","type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d-([01]\\d|2[0-3]):[0-5]\\d$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:ModifyDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/backups":{"get":{"operationId":"docdb.backups.list","summary":"Backups, the recoverable window and this cluster’s restores","description":"`docdb:ListDocdbBackups` Backups, the recoverable window and this cluster’s restores.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:ListDocdbBackups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"docdb.backups.create","summary":"Take a full backup now","description":"`docdb:CreateDocdbBackup` Take a full backup now. Answers 202 `requested`; the node picks it up within a minute and reports back. Kept until you delete it where `keepsByHand` is true (at most 20 per cluster); otherwise it follows the retention window.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:CreateDocdbBackup","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/backups/{backupId}":{"delete":{"operationId":"docdb.backups.delete-backup","summary":"Delete a backup taken by hand that is kept until deleted","description":"`docdb:DeleteDocdbBackup` Delete a backup taken by hand that is kept until deleted. Older than the retention window, it is expired at once and removed from the repository within a minute; inside the window it follows the window from now on.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"backupId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DeleteDocdbBackup","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/deletion-protection":{"patch":{"operationId":"docdb.clusters.set-deletion-protection","summary":"Turn deletion protection on or off; while on, delete is refused","description":"`docdb:ModifyDocdbCluster` Turn deletion protection on or off; while on, delete is refused.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:ModifyDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/events":{"get":{"operationId":"docdb.clusters.events","summary":"Activity: provisioning steps, failovers, what the nodes reported","description":"`docdb:DescribeDocdbClusters` Activity: provisioning steps, failovers, what the nodes reported.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/health":{"get":{"operationId":"docdb.clusters.health","summary":"What the health check (every two minutes) found: FerretDB answering on 27017 on each node, replication, disk, certificate","description":"`docdb:DescribeDocdbClusters` What the health check (every two minutes) found: FerretDB answering on 27017 on each node, replication, disk, certificate.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/logs":{"get":{"operationId":"docdb.clusters.logs","summary":"FerretDB’s log and the Postgres server log from every node, newest first. Kept 7 days","description":"`docdb:DescribeDocdbLogs` FerretDB’s log and the Postgres server log from every node, newest first. Kept 7 days.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"start","in":"query","required":false,"schema":{"description":"Default: 24 hours before end"}},{"name":"end","in":"query","required":false,"schema":{"description":"Default: now"}},{"name":"contains","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"node","in":"query","required":false,"schema":{"description":"A node ordinal","type":"integer","minimum":1,"maximum":99}},{"name":"severity","in":"query","required":false,"schema":{"description":"FerretDB INFO is log, WARN is warning","type":"string","enum":["debug","info","notice","log","warning","error","fatal","panic"]}},{"name":"source","in":"query","required":false,"schema":{"description":"ferretdb: FerretDB’s lines only; postgres: the Postgres server log only","type":"string","enum":["ferretdb","postgres"]}},{"name":"limit","in":"query","required":false,"schema":{"default":200,"type":"integer","minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbLogs","x-ews-mutates":false,"x-ews-sensitive":true}},"/docdb/api/clusters/{id}/master-password/rotate":{"post":{"operationId":"docdb.clusters.rotate-master-password","summary":"Give the master user a new password, filed as a new version in Secrets","description":"`docdb:RotateDocdbMasterPassword` Give the master user a new password, filed as a new version in Secrets. The old password stops working at once. Apps bound to the cluster (MONGODB_URL) are redeployed with the new one.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:RotateDocdbMasterPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/node-type":{"patch":{"operationId":"docdb.clusters.modify-node-type","summary":"Change the machine type; a 3-node cluster is resized node by node and stays available","description":"`docdb:ModifyDocdbCluster` Change the machine type; a 3-node cluster is resized node by node and stays available. Answers 202; progress on events. A single node is down for one restart (about a minute).","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from server-types, e.g. performance-4; 8 GiB at least for a 3-node cluster. Provider type names still accepted, deprecated."}},"required":["nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:ModifyDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/nodes":{"get":{"operationId":"docdb.clusters.nodes","summary":"The machines: role (primary/replica), zone, addresses, disk use, last report","description":"`docdb:DescribeDocdbClusters` The machines: role (primary/replica), zone, addresses, disk use, last report.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/restore":{"post":{"operationId":"docdb.backups.restore","summary":"Restore into a NEW cluster: to the latest moment, a timestamp in the window, or the end of a backup","description":"`docdb:RestoreDocdbCluster` Restore into a NEW cluster: to the latest moment, a timestamp in the window, or the end of a backup. Answers 202 with the restore job and the new cluster (`creating`). The source is untouched. The new cluster gets its own master password in Secrets, the source’s users and documents as of the target.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The new cluster’s name"},"nodeType":{"description":"Default: the source’s instance type, e.g. performance-2","type":"string","minLength":1,"maxLength":32},"nodes":{"description":"1 (default) or 3 nodes, whatever the source has","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"kmsKeyId":{"description":"CMK for the new disks; null: the platform key; omitted: the source’s","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"latest"}},"required":["targetIdentifier","recoveryTarget"]},{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The new cluster’s name"},"nodeType":{"description":"Default: the source’s instance type, e.g. performance-2","type":"string","minLength":1,"maxLength":32},"nodes":{"description":"1 (default) or 3 nodes, whatever the source has","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"kmsKeyId":{"description":"CMK for the new disks; null: the platform key; omitted: the source’s","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"time"},"recoveryTargetTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["targetIdentifier","recoveryTarget","recoveryTargetTime"]},{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The new cluster’s name"},"nodeType":{"description":"Default: the source’s instance type, e.g. performance-2","type":"string","minLength":1,"maxLength":32},"nodes":{"description":"1 (default) or 3 nodes, whatever the source has","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"kmsKeyId":{"description":"CMK for the new disks; null: the platform key; omitted: the source’s","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"label"},"recoveryTargetLabel":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["targetIdentifier","recoveryTarget","recoveryTargetLabel"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:RestoreDocdbCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/users":{"get":{"operationId":"docdb.users.list","summary":"The master user and the cluster’s users, with the Secrets holding their passwords","description":"`docdb:DescribeDocdbClusters` The master user and the cluster’s users, with the Secrets holding their passwords.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"docdb.users.create","summary":"Add a user; its generated password is filed in Secrets","description":"`docdb:CreateDocdbUser` Add a user; its generated password is filed in Secrets. Every user has full read/write access to all databases (FerretDB 2.7 enforces no roles); a role or database in the body is refused. The wire commands createUser, updateUser and dropUser are refused by the cluster: manage users here.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9_]{1,40}$","description":"2–41 lower-case letters, digits, underscores; not the master user’s name"}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:CreateDocdbUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/users/{userId}":{"delete":{"operationId":"docdb.users.delete","summary":"Remove a user and its secret; new sign-ins with its password fail at once","description":"`docdb:DeleteDocdbUser` Remove a user and its secret; new sign-ins with its password fail at once. Refused with 409 while an app is bound to the cluster as this user.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DeleteDocdbUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/clusters/{id}/users/{userId}/rotate-password":{"post":{"operationId":"docdb.users.rotate-password","summary":"A new password for one user, filed as a new version of its secret","description":"`docdb:RotateDocdbUserPassword` A new password for one user, filed as a new version of its secret. Apps bound to the cluster as this user are redeployed with it.","tags":["Document Database"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewdoc-[0-9a-f]{12}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:RotateDocdbUserPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/docdb/api/server-types":{"get":{"operationId":"docdb.clusters.server-types","summary":"The machine types a node can run on, with price and stock","description":"`docdb:DescribeDocdbClusters` The machine types a node can run on, with price and stock.","tags":["Document Database"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"docdb:DescribeDocdbClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/availability-zones":{"get":{"operationId":"ec2.availability-zones.list","summary":"List the availability zones of a region, with the location behind each","description":"`ec2:DescribeAvailabilityZones` List the availability zones of a region, with the location behind each.","tags":["Compute"],"parameters":[{"name":"regionId","in":"query","required":false,"schema":{"description":"Only this region’s zones","type":"string","minLength":1,"maxLength":32}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeAvailabilityZones","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/elastic-ips":{"get":{"operationId":"ec2.elastic-ips.list","summary":"List elastic IPs","description":"`ec2:DescribeAddresses` List elastic IPs.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeAddresses","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.elastic-ips.allocate","summary":"Allocate an elastic IP in a region","description":"`ec2:AllocateAddress` Allocate an elastic IP in a region.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"type":"string","minLength":1,"description":"The region to allocate the address in, e.g. de1"},"tags":{"description":"Tags for the address; omitted: none, and associating it with an instance may copy that instance’s tags","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["regionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AllocateAddress","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/elastic-ips/{id}":{"delete":{"operationId":"ec2.elastic-ips.release","summary":"Release an elastic IP","description":"`ec2:ReleaseAddress` Release an elastic IP.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ReleaseAddress","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/elastic-ips/{id}/associate":{"post":{"operationId":"ec2.elastic-ips.associate","summary":"Attach an elastic IP to an instance","description":"`ec2:AssociateAddress` Attach an elastic IP to an instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$","description":"The instance to attach the address to (i-…)"}},"required":["instanceId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AssociateAddress","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/elastic-ips/{id}/disassociate":{"post":{"operationId":"ec2.elastic-ips.disassociate","summary":"Detach an elastic IP from its instance","description":"`ec2:DisassociateAddress` Detach an elastic IP from its instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DisassociateAddress","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instance-type-offerings":{"get":{"operationId":"ec2.instance-type-offerings.list","summary":"List instance types per availability zone with inStock and when it last changed (e.g. \"arm-2 sold out in de1a, in stock in de1b\")","description":"`ec2:DescribeInstanceTypeOfferings` List instance types per availability zone with inStock and when it last changed (e.g. \"arm-2 sold out in de1a, in stock in de1b\").","tags":["Compute"],"parameters":[{"name":"regionId","in":"query","required":false,"schema":{"description":"Region (default: the caller’s)","type":"string","minLength":1,"maxLength":32}},{"name":"availabilityZoneId","in":"query","required":false,"schema":{"description":"Only this zone","type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"}},{"name":"instanceType","in":"query","required":false,"schema":{"description":"Only this instance type, e.g. performance-2","type":"string","pattern":"^[a-z0-9-]{2,24}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstanceTypeOfferings","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/instances":{"get":{"operationId":"ec2.instances.list","summary":"List instances","description":"`ec2:DescribeInstances` List instances.","tags":["Compute"],"parameters":[{"name":"state","in":"query","required":false,"schema":{"description":"Only instances in this state","type":"string","enum":["pending","running","rebooting","stopping","stopped","shutting-down","terminated"]}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many, oldest first (default 100)","type":"integer","minimum":1,"maximum":500}},{"name":"offset","in":"query","required":false,"schema":{"description":"Skip this many first: the next page is offset + limit (default 0)","type":"integer","minimum":0,"maximum":1000000}},{"name":"tag","in":"query","required":false,"schema":{"description":"Only instances carrying these tags: \"env=preview,slot=3\" (all must match; a bare key: present)","type":"string","minLength":1,"maxLength":512}},{"name":"name","in":"query","required":false,"schema":{"description":"Only instances whose name or id contains this","type":"string","minLength":1,"maxLength":64}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.instances.run","summary":"Launch an instance","description":"`ec2:RunInstances` Launch an instance.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"serverType":{"description":"An instance type, e.g. performance-2 (ec2 instance-types list). Give this or sizeClass. The provider’s own type names are still accepted, deprecated.","type":"string","minLength":1},"sizeClass":{"type":"string","enum":["s-2","s-4","s-8","s-16","m-4","d-2","d-8","a-2","a-4","a-8","a-16"],"description":"A size class instead of a provider type: s-2 (2 vCPU / 4 GiB), s-4 (4 / 8), s-8 (8 / 16), s-16 (16 / 32), m-4 (4 / 32), d-2 (2 dedicated / 8), d-8 (8 dedicated / 32), a-2, a-4, a-8, a-16 (ARM, as s-*); it becomes the smallest type of your provider that fits"},"imageId":{"description":"An OS image from the catalog. Give this or machineImageId, not both.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"machineImageId":{"description":"One of your machine images (ewi-…), to launch a copy of a snapshot.","type":"string","pattern":"^ewi-[0-9a-f]{6,32}$"},"regionId":{"type":"string","minLength":1,"description":"The region to launch in, e.g. de1"},"availabilityZoneId":{"description":"Zone to run in (de1a = Falkenstein, de1b = Nuremberg); default the subnet’s, else de1a","type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"vpcId":{"description":"The VPC to join; omitted: the region’s default VPC, created the first time it is needed","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"description":"A display name; omitted: none","type":"string","maxLength":64},"sshKeyPairId":{"description":"A KMS SSH key pair (kms ssh-key-pairs)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"keyPairId":{"description":"Instead of sshKeyPairId: a Compute key pair (ec2 key-pairs); not both","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"userData":{"description":"A cloud-init script run at first boot, passed through unchanged","type":"string"},"tags":{"description":"Tags for the instance (and its launch volumes); your organization’s required keys must be present","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"securityGroupIds":{"description":"Security groups to attach; omitted: none, so the instance is not filtered","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"subnetId":{"description":"A subnet of the VPC: the instance gets a fixed private address in its range and runs in its zone","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"enablePublicIpv4":{"description":"Give the machine a public IPv4 (default true); false: IPv6 only, IPv4 out through the VPC’s NAT gateway if it has one","type":"boolean"},"osPatching":{"description":"Keep OS patched: install the platform patch reporter; security updates install nightly and reboots happen in the 02:00–05:00 UTC window. Ubuntu images only.","type":"boolean"},"connect":{"description":"Deutsche Cloud Connect (default true): the machine keeps one outbound SSH connection to Deutsche Cloud so the console terminal and adding keys work with no inbound port. false: nothing is installed.","type":"boolean"},"iamRoleName":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[\\w+=,.@-]+$","description":"IAM role the machine acts as (needs iam:PassRole on it): it gets 60-minute credentials for it through its instance identity (`ews-instance credentials`), with no key in user data"},"volumes":{"description":"Up to 4 extra volumes made with the instance in its zone, attached once it runs (needs ec2:CreateVolume and ec2:AttachVolume); encrypted and deleted with the instance unless told otherwise. CLI: --volumes '{\"sizeGib\":40}'","maxItems":4,"type":"array","items":{"type":"object","properties":{"sizeGib":{"type":"integer","minimum":10,"maximum":10000},"name":{"type":"string","minLength":1,"maxLength":64},"encrypted":{"description":"Default true","type":"boolean"},"deleteOnTermination":{"description":"Default true","type":"boolean"}},"required":["sizeGib"]}},"publicHostname":{"description":"Own hosts only: a name in one of your DNS zones (and *.name) that reaches this machine through the site’s front: HTTPS by SNI, SSH through the jump on port 2222. Needs dns:ChangeRecords on that zone; removed at terminate.","type":"string"},"idleSuspendMinutes":{"description":"Own hosts only: suspend the machine (memory saved) after this many idle minutes; the next HTTPS request or SSH connection through the front wakes it.","type":"integer","minimum":10,"maximum":10080},"requiredHostTags":{"description":"Own hosts only: capability tags the machine’s host must carry (a name or name:value, e.g. fsync:high, cpu:a); only hosts with every one take it, else it waits saying which tag is missing. CLI: --required-host-tags fsync:high","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9-]+(:[a-z0-9.-]+)?$"}}},"required":["regionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:RunInstances","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}":{"get":{"operationId":"ec2.instances.get","summary":"Describe one instance","description":"`ec2:DescribeInstances` Describe one instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"ec2.instances.terminate","summary":"Terminate an instance and delete its machine","description":"`ec2:TerminateInstances` Terminate an instance and delete its machine.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:TerminateInstances","x-ews-mutates":true,"x-ews-sensitive":false},"patch":{"operationId":"ec2.instances.start+stop+shutdown+reboot","summary":"start, stop, shutdown, reboot — selected by the request body","description":"Several operations share this method and path; the handler picks one from the body.\n- `ec2.instances.start` — `ec2:StartInstances` Start a stopped instance.\n- `ec2.instances.stop` — `ec2:StopInstances` Power off an instance.\n- `ec2.instances.shutdown` — `ec2:StopInstances` Ask the guest OS to shut down cleanly.\n- `ec2.instances.reboot` — `ec2:RebootInstances` Reboot an instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"start"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"stop"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"shutdown"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"reboot"}},"required":["action"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:StartInstances","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-operations":["ec2.instances.start","ec2.instances.stop","ec2.instances.shutdown","ec2.instances.reboot"]}},"/ec2/api/instances/{id}/actions/resize":{"post":{"operationId":"ec2.instances.resize","summary":"Change an instance server type","description":"`ec2:ModifyInstanceAttribute` Change an instance server type.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"serverType":{"type":"string","minLength":1,"description":"The new instance type, e.g. performance-4 (provider names still accepted, deprecated)"}},"required":["serverType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ModifyInstanceAttribute","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/connect":{"get":{"operationId":"ec2.instances.connect-status","summary":"Deutsche Cloud Connect on this instance: connected or not, who can log in, the keys Deutsche Cloud added","description":"`ec2:DescribeInstances` Deutsche Cloud Connect on this instance: connected or not, who can log in, the keys Deutsche Cloud added. `state`: connected, pending (booting), disconnected (down, or `systemctl disable ews-connect` on the machine), off (launched with connect: false), not-installed (launched before Connect). `enableCommand` turns it on from the machine.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/identity":{"get":{"operationId":"ec2.instances.get-identity","summary":"Instance identity: its role, when the secret was rotated and last used, from where","description":"`ec2:DescribeInstances` Instance identity: its role, when the secret was rotated and last used, from where. The secret itself is never readable through the API: it lives on the machine in /etc/ews/instance-identity (root, 0600). On the machine, `ews-instance credentials` trades it for 60-minute credentials of the instance role.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/keys":{"post":{"operationId":"ec2.instances.add-key","summary":"Add a key pair to a running instance (root and its default user), no reboot","description":"`ec2:AddInstanceKey` Add a key pair to a running instance (root and its default user), no reboot. Through Deutsche Cloud Connect: works while the instance is connected (`connect-status`). The line in authorized_keys ends in `ews-key:<keyPairId>`, so `remove-key` takes out exactly that line. On an instance without Connect: 409 with what is possible.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyPairId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The key pair to add (ec2 key pairs)"},"users":{"description":"Whose authorized_keys get it: root, the image’s default user, or both (the default)","minItems":1,"maxItems":2,"type":"array","items":{"type":"string","enum":["root","default"]}}},"required":["keyPairId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AddInstanceKey","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["ec2:DescribeKeyPairs"]}},"/ec2/api/instances/{id}/keys/{keyPairId}":{"delete":{"operationId":"ec2.instances.remove-key","summary":"Remove a key pair Deutsche Cloud added from a running instance","description":"`ec2:RemoveInstanceKey` Remove a key pair Deutsche Cloud added from a running instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},{"name":"keyPairId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:RemoveInstanceKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/name":{"put":{"operationId":"ec2.instances.rename","summary":"Set or clear an instance display name","description":"`ec2:ModifyInstanceAttribute` Set or clear an instance display name.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"The new display name; null clears it"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ModifyInstanceAttribute","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/patch-state":{"get":{"operationId":"ec2.instances.get-patch-state","summary":"OS patch state: pending security updates, reboot needed or scheduled, kernel","description":"`ec2:DescribeInstances` OS patch state: pending security updates, reboot needed or scheduled, kernel. `data` is null for an instance that does not run the patch reporter (launched without `osPatching`). App boxes always run it.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/role":{"put":{"operationId":"ec2.instances.set-role","summary":"Give the instance an IAM role it gets short-lived credentials for","description":"`ec2:AssociateInstanceRole` Give the instance an IAM role it gets short-lived credentials for. Also needs iam:PassRole on the role.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"iamRoleName":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[\\w+=,.@-]+$","description":"IAM role the machine acts as (needs iam:PassRole on it): it gets 60-minute credentials for it through its instance identity (`ews-instance credentials`), with no key in user data"}},"required":["iamRoleName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AssociateInstanceRole","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ec2.instances.remove-role","summary":"Take the instance role away; sessions already issued expire within the hour","description":"`ec2:DisassociateInstanceRole` Take the instance role away; sessions already issued expire within the hour.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DisassociateInstanceRole","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/security-groups":{"get":{"operationId":"ec2.instances.security-groups","summary":"List the security groups attached to an instance","description":"`ec2:DescribeInstances` List the security groups attached to an instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"ec2.instances.set-security-groups","summary":"Replace the security groups attached to an instance","description":"`ec2:ModifyInstanceAttribute` Replace the security groups attached to an instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"securityGroupIds":{"maxItems":16,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The complete new set of groups; an empty list detaches them all"}},"required":["securityGroupIds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ModifyInstanceAttribute","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/sessions":{"post":{"operationId":"ec2.instances.start-session","summary":"Open a terminal on the instance (Deutsche Cloud Connect, no inbound port)","description":"`ec2:StartSession` Open a terminal on the instance (Deutsche Cloud Connect, no inbound port). Answers a single-use `ticket` valid 60 s and `websocketUrl`. Open the WebSocket with the subprotocols `ews.terminal` and `ews.ticket.<ticket>`; binary frames are the terminal’s bytes, text frames `{\"type\":\"resize\",\"cols\":…,\"rows\":…}`. `dcloud ec2 instances connect <id>` does this for you.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"loginUser":{"description":"Log in as root (the default) or the image’s default user","type":"string","pattern":"^[a-z_][a-z0-9_-]{0,31}$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:StartSession","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"ec2.instances.list-sessions","summary":"Terminal sessions on this instance: who, when, how long, bytes","description":"`ec2:DescribeSessions` Terminal sessions on this instance: who, when, how long, bytes.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSessions","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/sessions/{sessionId}":{"delete":{"operationId":"ec2.instances.end-session","summary":"End a terminal session (your own needs no permission)","description":"`ec2:TerminateSession` End a terminal session (your own needs no permission).","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^ses-[0-9a-f]{16}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:TerminateSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/sessions/{sessionId}/attach":{"post":{"operationId":"ec2.instances.attach-session","summary":"A fresh ticket to re-attach to your own session (the shell waits 60 s after a drop)","description":"`ec2:StartSession` A fresh ticket to re-attach to your own session (the shell waits 60 s after a drop).","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^ses-[0-9a-f]{16}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:StartSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/tags":{"patch":{"operationId":"ec2.instances.set-tags","summary":"Relabel an instance in one call: set some tags, remove others","description":"`tags:TagResource` Relabel an instance in one call: set some tags, remove others. Setting needs tags:TagResource and removing tags:UntagResource on the instance. Answers the tags it has afterwards. Find instances by tag with `dcloud ec2 instances list --tag key=value`.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"set":{"description":"Tags to add or overwrite","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"remove":{"description":"Keys to remove","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:TagResource","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/user-data":{"get":{"operationId":"ec2.instances.get-user-data","summary":"Read the cloud-init user data an instance booted with","description":"`ec2:GetInstanceUserData` Read the cloud-init user data an instance booted with.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:GetInstanceUserData","x-ews-mutates":false,"x-ews-sensitive":true}},"/ec2/api/instances/{id}/volume-helper":{"post":{"operationId":"ec2.instances.install-volume-helper","summary":"Get the script that lets an older instance open encrypted volumes","description":"`ec2:InstallVolumeHelper` Get the script that lets an older instance open encrypted volumes. For an instance launched before the volume helper existed. Run `data.script` as root on the instance; it installs the helper with a fresh credential for this instance and reports in, after which encrypted volumes can be attached. Idempotent. `data.installed` says whether it already reported.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:InstallVolumeHelper","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/instances/{id}/wait":{"get":{"operationId":"ec2.instances.wait","summary":"Wait until the instance is running (or stopped, or terminated)","description":"`ec2:DescribeInstances` Wait until the instance is running (or stopped, or terminated). Answers the instance as soon as it is in the state, or 408 after timeoutSeconds (call again to keep waiting), or 409 if it terminated first. Running means the machine exists and has its addresses.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},{"name":"state","in":"query","required":false,"schema":{"description":"Default running","type":"string","enum":["running","stopped","terminated"]}},{"name":"timeoutSeconds","in":"query","required":false,"schema":{"description":"At most this long (default 120, max 300)","type":"integer","minimum":1,"maximum":300}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/key-pairs":{"post":{"operationId":"ec2.key-pairs.import","summary":"Register an existing SSH public key","description":"`ec2:ImportKeyPair` Register an existing SSH public key. One store with `kms ssh-key-pairs` (list, generate, sync from a password manager): the pair is the same object there, under the same id.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"regionId":{"description":"Ignored: an SSH key is not regional. Kept for old clients","type":"string","minLength":1},"publicKey":{"type":"string","minLength":1,"description":"The public key in OpenSSH format, e.g. \"ssh-ed25519 AAAA… comment\""},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","publicKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ImportKeyPair","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/key-pairs/{id}":{"delete":{"operationId":"ec2.key-pairs.delete","summary":"Delete a key pair","description":"`ec2:DeleteKeyPair` Delete a key pair. Refused with 409 while a live instance still names the pair. Machines already launched with it keep the key installed on them.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteKeyPair","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/machine-images":{"get":{"operationId":"ec2.machine-images.list","summary":"List machine images owned by the org","description":"`ec2:DescribeImages` List machine images owned by the org.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeImages","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.machine-images.create","summary":"Snapshot a running instance into a machine image","description":"`ec2:CreateImage` Snapshot a running instance into a machine image.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","minLength":1,"description":"The instance to snapshot (i-…), running or stopped"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"description":{"description":"Free text; omitted: none","type":"string","maxLength":255},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["instanceId","name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateImage","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/machine-images/{id}":{"delete":{"operationId":"ec2.machine-images.deregister","summary":"Delete the provider snapshot and mark the image deregistered","description":"`ec2:DeregisterImage` Delete the provider snapshot and mark the image deregistered. The row survives in the `deregistered` state — instances point at it — so this is not a delete. A platform base image is refused with 409.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewi-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeregisterImage","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/nat-gateways":{"get":{"operationId":"ec2.nat-gateways.list","summary":"List NAT gateways","description":"`ec2:DescribeNatGateways` List NAT gateways.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeNatGateways","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.nat-gateways.create","summary":"Give a VPC a NAT gateway (one per VPC); answers 202 while it is built","description":"`ec2:CreateNatGateway` Give a VPC a NAT gateway (one per VPC); answers 202 while it is built. A platform-run machine with a public IPv4 at a pinned address in the VPC, plus the network route 0.0.0.0/0 to it. Instances launched afterwards with `enablePublicIpv4: false` route through it on their own; older ones need one command (see the compute docs). One machine: not redundant.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The VPC to serve"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["vpcId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateNatGateway","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/nat-gateways/{id}":{"get":{"operationId":"ec2.nat-gateways.get","summary":"A NAT gateway: state, egress address, address in the VPC","description":"`ec2:DescribeNatGateways` A NAT gateway: state, egress address, address in the VPC.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^nat-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeNatGateways","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"ec2.nat-gateways.delete","summary":"Delete a NAT gateway: the route first, then its machine","description":"`ec2:DeleteNatGateway` Delete a NAT gateway: the route first, then its machine. Machines without a public IPv4 lose IPv4 internet access. Answers 202.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^nat-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteNatGateway","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/security-groups":{"get":{"operationId":"ec2.security-groups.list","summary":"List security groups, optionally filtered by VPC","description":"`ec2:DescribeSecurityGroups` List security groups, optionally filtered by VPC.","tags":["Compute"],"parameters":[{"name":"vpcId","in":"query","required":false,"schema":{"description":"Only those in this VPC; omitted: all","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSecurityGroups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.security-groups.create","summary":"Create a security group with optional initial rules","description":"`ec2:CreateSecurityGroup` Create a security group with optional initial rules.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"description":{"description":"Free text; omitted: none","type":"string","maxLength":255},"rules":{"description":"Initial rules, each { direction, protocol, fromPort, toPort, cidrIpv4, description } as for adding a rule; omitted: none","type":"array","items":{"type":"object","properties":{"direction":{"type":"string","enum":["inbound","outbound"]},"protocol":{"type":"string","enum":["tcp","udp","icmp"]},"fromPort":{"type":"integer","minimum":0,"maximum":65535},"toPort":{"type":"integer","minimum":0,"maximum":65535},"cidrIpv4":{"default":"0.0.0.0/0","type":"string"},"description":{"type":"string","maxLength":255}},"required":["direction","protocol"]}},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateSecurityGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/security-groups/{id}":{"get":{"operationId":"ec2.security-groups.get","summary":"Describe one security group and its rules","description":"`ec2:DescribeSecurityGroups` Describe one security group and its rules.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSecurityGroups","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"ec2.security-groups.delete","summary":"Delete a security group","description":"`ec2:DeleteSecurityGroup` Delete a security group.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteSecurityGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/security-groups/{id}/rules":{"post":{"operationId":"ec2.security-groups.authorize-ingress+authorize-egress","summary":"authorize-ingress, authorize-egress — selected by the request body","description":"Several operations share this method and path; the handler picks one from the body.\n- `ec2.security-groups.authorize-ingress` — `ec2:AuthorizeSecurityGroupIngress` Add an inbound rule.\n- `ec2.security-groups.authorize-egress` — `ec2:AuthorizeSecurityGroupEgress` Add an outbound rule.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"direction":{"type":"string","const":"inbound"},"protocol":{"type":"string","enum":["tcp","udp","icmp"],"description":"The IP protocol the rule matches"},"fromPort":{"description":"First port of the range; omitted: every port. Ignored for ICMP","type":"integer","minimum":0,"maximum":65535},"toPort":{"description":"Last port of the range; omitted: fromPort alone","type":"integer","minimum":0,"maximum":65535},"cidrIpv4":{"default":"0.0.0.0/0","description":"Where traffic may come from: a CIDR block or a single address (IPv4 or IPv6); default 0.0.0.0/0","type":"string"},"description":{"description":"Free text; omitted: none","type":"string","maxLength":255}},"required":["direction","protocol"]},{"type":"object","properties":{"direction":{"type":"string","const":"outbound"},"protocol":{"type":"string","enum":["tcp","udp","icmp"],"description":"The IP protocol the rule matches"},"fromPort":{"description":"First port of the range; omitted: every port. Ignored for ICMP","type":"integer","minimum":0,"maximum":65535},"toPort":{"description":"Last port of the range; omitted: fromPort alone","type":"integer","minimum":0,"maximum":65535},"cidrIpv4":{"default":"0.0.0.0/0","description":"Where traffic may go: a CIDR block or a single address (IPv4 or IPv6); default 0.0.0.0/0","type":"string"},"description":{"description":"Free text; omitted: none","type":"string","maxLength":255}},"required":["direction","protocol"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AuthorizeSecurityGroupIngress","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-operations":["ec2.security-groups.authorize-ingress","ec2.security-groups.authorize-egress"]}},"/ec2/api/security-groups/{id}/rules/{ruleId}":{"delete":{"operationId":"ec2.security-groups.revoke-rule","summary":"Remove a rule from a security group","description":"`ec2:RevokeSecurityGroupIngress` Remove a rule from a security group. The route reads the rule direction from the stored row, so which of the two Revoke actions it checks is not visible from the request.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:RevokeSecurityGroupIngress","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["ec2:RevokeSecurityGroupEgress"]}},"/ec2/api/sessions":{"get":{"operationId":"ec2.sessions.list","summary":"Terminal sessions: who opened which instance, when, for how long","description":"`ec2:DescribeSessions` Terminal sessions: who opened which instance, when, for how long.","tags":["Compute"],"parameters":[{"name":"instanceId","in":"query","required":false,"schema":{"description":"Only sessions on this instance (i-…); omitted: every instance","type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},{"name":"open","in":"query","required":false,"schema":{"description":"true: only sessions not yet ended; omitted or false: all","type":"string","enum":["true","false"]}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"description":"At most this many, newest first (default 50)","type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSessions","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/snapshot-policies":{"get":{"operationId":"ec2.snapshot-policies.list","summary":"List snapshot policies","description":"`ec2:DescribeSnapshotPolicies` List snapshot policies.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSnapshotPolicies","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.snapshot-policies.create","summary":"Snapshot instances on a schedule and keep the newest N per instance","description":"`ec2:CreateSnapshotPolicy` Snapshot instances on a schedule and keep the newest N per instance. Targets are instance ids, tags, or both; at least one is required. A snapshot of a running instance is crash-consistent, like an EBS snapshot.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"description":{"description":"Free text; null clears it","anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"enabled":{"description":"A paused policy takes nothing and keeps its images","type":"boolean"},"targetInstanceIds":{"description":"Instances to snapshot (i-…)","maxItems":100,"type":"array","items":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},"targetTags":{"description":"Also snapshot every instance that carries all of these tags","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"intervalHours":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Hours between runs: 1, 2, 3, 4, 6, 8, 12, 24 or 168 (weekly, on Mondays)"},"startTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"HH:MM UTC; runs fall on this time plus whole intervals"},"retainCount":{"type":"integer","minimum":1,"maximum":100,"description":"Images kept per instance; older ones this policy took are deregistered"},"regionId":{"type":"string","minLength":1,"maxLength":32,"description":"The region the policy belongs to, e.g. de1"}},"required":["name","intervalHours","startTime","retainCount","regionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateSnapshotPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/snapshot-policies/{id}":{"get":{"operationId":"ec2.snapshot-policies.get","summary":"A snapshot policy, with the images it holds","description":"`ec2:DescribeSnapshotPolicies` A snapshot policy, with the images it holds.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^esp-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSnapshotPolicies","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ec2.snapshot-policies.update","summary":"Change, pause or resume a snapshot policy","description":"`ec2:UpdateSnapshotPolicy` Change, pause or resume a snapshot policy.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^esp-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"description":{"description":"Free text; null clears it","anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"enabled":{"description":"A paused policy takes nothing and keeps its images","type":"boolean"},"targetInstanceIds":{"description":"Instances to snapshot (i-…)","maxItems":100,"type":"array","items":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$"}},"targetTags":{"description":"Also snapshot every instance that carries all of these tags","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"intervalHours":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Hours between runs: 1, 2, 3, 4, 6, 8, 12, 24 or 168 (weekly, on Mondays)"},"startTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"HH:MM UTC; runs fall on this time plus whole intervals"},"retainCount":{"type":"integer","minimum":1,"maximum":100,"description":"Images kept per instance; older ones this policy took are deregistered"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:UpdateSnapshotPolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ec2.snapshot-policies.delete","summary":"Delete a snapshot policy; the images it took are kept","description":"`ec2:DeleteSnapshotPolicy` Delete a snapshot policy; the images it took are kept.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^esp-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteSnapshotPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/snapshot-policies/{id}/run":{"post":{"operationId":"ec2.snapshot-policies.run","summary":"Run a snapshot policy now, outside its schedule","description":"`ec2:UpdateSnapshotPolicy` Run a snapshot policy now, outside its schedule.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^esp-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:UpdateSnapshotPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/snapshots":{"get":{"operationId":"ec2.snapshots.list","summary":"List volume snapshots (optionally of one volume)","description":"`ec2:DescribeSnapshots` List volume snapshots (optionally of one volume).","tags":["Compute"],"parameters":[{"name":"volumeId","in":"query","required":false,"schema":{"description":"Only snapshots of this volume; omitted: all","type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSnapshots","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/snapshots/{id}":{"get":{"operationId":"ec2.snapshots.get","summary":"Describe a volume snapshot and its progress","description":"`ec2:DescribeSnapshots` Describe a volume snapshot and its progress.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^snap-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"ec2.snapshots.delete","summary":"Delete a volume snapshot and the data no other snapshot uses","description":"`ec2:DeleteSnapshot` Delete a volume snapshot and the data no other snapshot uses.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^snap-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/subnets":{"get":{"operationId":"ec2.subnets.list","summary":"List subnets, optionally filtered by VPC","description":"`ec2:DescribeSubnets` List subnets, optionally filtered by VPC.","tags":["Compute"],"parameters":[{"name":"vpcId","in":"query","required":false,"schema":{"description":"Only those in this VPC; omitted: all","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeSubnets","x-ews-mutates":false,"x-ews-sensitive":false}},"/ec2/api/subnets/{id}":{"delete":{"operationId":"ec2.subnets.delete","summary":"Delete a subnet no instance holds an address in","description":"`ec2:DeleteSubnet` Delete a subnet no instance holds an address in.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteSubnet","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes":{"get":{"operationId":"ec2.volumes.list","summary":"List volumes","description":"`ec2:DescribeVolumes` List volumes.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeVolumes","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.volumes.create","summary":"Create a volume in a region","description":"`ec2:CreateVolume` Create a volume in a region. Encrypted (LUKS2, key per volume from KMS) unless `encrypted` is false. An encrypted volume opens at `/dev/mapper/ews-vol-<provider volume id>` on an instance launched with the volume helper; format and mount that device. `kmsKeyId` wraps the volume key under one of your KMS keys (needs `kms:Encrypt` on it); disabling or deleting that key makes the volume unopenable.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A display name"},"sizeGib":{"type":"integer","minimum":10,"maximum":10000,"description":"Size in GiB; a restore needs at least the snapshot’s size"},"regionId":{"type":"string","minLength":1,"description":"The region to create it in, e.g. de1"},"availabilityZoneId":{"description":"The zone it lives in; it attaches only to instances there. Default de1a","type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"tags":{"description":"Tags for the volume; your organization’s required keys must be present","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"encrypted":{"default":true,"description":"Encrypt the volume at rest with a key of its own, held in KMS (default true); a restore follows the snapshot instead","type":"boolean"},"kmsKeyId":{"description":"One of your KMS keys to wrap the volume key (needs kms:Encrypt on it); omitted: the platform key. Not with snapshotId","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"snapshotId":{"description":"Restore this volume snapshot onto the new volume (same zone, at least its size)","type":"string","pattern":"^snap-[0-9a-f]{6,32}$"}},"required":["name","sizeGib","regionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateVolume","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes/{id}":{"get":{"operationId":"ec2.volumes.get","summary":"Describe a volume","description":"`ec2:DescribeVolumes` Describe a volume.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeVolumes","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ec2.volumes.modify","summary":"Rename a volume or grow it","description":"`ec2:ModifyVolume` Rename a volume or grow it. A volume only grows, attached or not. Afterwards grow the filesystem on the instance (`resize2fs`, `xfs_growfs`); see the Compute guide.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name","type":"string","minLength":1,"maxLength":64},"sizeGib":{"description":"The new size in GiB; a volume only grows","type":"integer","minimum":10,"maximum":10000}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:ModifyVolume","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ec2.volumes.delete","summary":"Delete a detached volume and its data","description":"`ec2:DeleteVolume` Delete a detached volume and its data.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteVolume","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes/{id}/attach":{"post":{"operationId":"ec2.volumes.attach","summary":"Attach a volume to an instance in the same region","description":"`ec2:AttachVolume` Attach a volume to an instance in the same region.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","pattern":"^i-[0-9a-f]{6,32}$","description":"The instance to attach to (i-…), in the volume’s zone and not terminated"}},"required":["instanceId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:AttachVolume","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes/{id}/detach":{"post":{"operationId":"ec2.volumes.detach","summary":"Detach a volume from its instance","description":"`ec2:DetachVolume` Detach a volume from its instance.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DetachVolume","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes/{id}/rotate-key":{"post":{"operationId":"ec2.volumes.rotate-key","summary":"Replace an encrypted volume’s LUKS passphrase with a new key","description":"`ec2:RotateVolumeKey` Replace an encrypted volume’s LUKS passphrase with a new key. Answers 202 with the key version. The instance it is attached to finishes the rotation within five minutes; a detached volume finishes when it is next attached. The dm-crypt volume key itself is not changed.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:RotateVolumeKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/volumes/{id}/snapshots":{"post":{"operationId":"ec2.snapshots.create","summary":"Snapshot a volume","description":"`ec2:CreateSnapshot` Snapshot a volume. Answers 202; poll the snapshot until `state` is `completed`. A helper machine of the platform attaches the volume and copies its raw blocks in 4 MiB chunks to the zone’s snapshot storage; an encrypted volume is copied as LUKS ciphertext, so the helper never holds its key. Unchanged chunks are stored once, so a second snapshot stores only what changed (`newBytes`). An attached volume is refused with 409 unless `stopInstance` is true: the instance is stopped, the volume copied, reattached and the instance started again (needs `ec2:StopInstances` on it).","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^vol-[0-9a-f]{6,32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A display name; omitted: none","type":"string","minLength":1,"maxLength":64},"description":{"description":"Free text; omitted: none","type":"string","maxLength":255},"stopInstance":{"default":false,"description":"The volume is attached: stop its instance for the snapshot and start it after","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/vpcs":{"get":{"operationId":"ec2.vpcs.list","summary":"List VPCs","description":"`ec2:DescribeVpcs` List VPCs.","tags":["Compute"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeVpcs","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ec2.vpcs.create","summary":"Create a VPC","description":"`ec2:CreateVpc` Create a VPC.","tags":["Compute"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"type":"string","minLength":1,"description":"The region to create it in, e.g. de1"},"name":{"description":"A display name; omitted: none","type":"string","maxLength":64},"cidrBlock":{"default":"10.0.0.0/16","description":"Private IPv4 range (RFC 1918), /8 to /24, starting on its boundary","type":"string"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["regionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateVpc","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/vpcs/{id}":{"get":{"operationId":"ec2.vpcs.get","summary":"Describe one VPC","description":"`ec2:DescribeVpcs` Describe one VPC.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DescribeVpcs","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"ec2.vpcs.delete","summary":"Delete a VPC","description":"`ec2:DeleteVpc` Delete a VPC.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:DeleteVpc","x-ews-mutates":true,"x-ews-sensitive":false}},"/ec2/api/vpcs/{id}/subnets":{"post":{"operationId":"ec2.subnets.create","summary":"Create a subnet: a range of the VPC in one availability zone","description":"`ec2:CreateSubnet` Create a subnet: a range of the VPC in one availability zone. An instance launched with `subnetId` gets an address in the range and runs in the subnet’s zone. Ranges are /16 to /28, inside the VPC and not overlapping another subnet.","tags":["Compute"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidrBlock":{"type":"string","minLength":9,"maxLength":18,"description":"IPv4 range inside the VPC, e.g. 10.0.1.0/24"},"availabilityZoneId":{"description":"The zone (e.g. de1b); default de1a","type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"name":{"description":"A display name; omitted: none","type":"string","maxLength":64},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["cidrBlock"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ec2:CreateSubnet","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/lifecycle-defaults":{"get":{"operationId":"ecr.lifecycle-defaults.get","summary":"Read the default that applies, and the platform default","description":"`ecr:GetLifecyclePolicy` Read the default that applies, and the platform default.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"ecr.lifecycle-defaults.put","summary":"Set the default and whether it is active, preview-only or off","description":"`ecr:PutLifecyclePolicy` Set the default and whether it is active, preview-only or off. Organizations created before the defaults existed see them preview-only until they enable them here. The answer says what would expire across the inheriting repositories.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"version":{"type":"string","const":"ews-lifecycle/v1"},"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"priority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"select":{"type":"object","properties":{"tagStatus":{"default":"any","type":"string","enum":["tagged","untagged","any"]},"tagPatterns":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"tagPrefixes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"namePrefix":{"type":"string","minLength":1,"maxLength":256},"prerelease":{"type":"boolean"}},"additionalProperties":false},"when":{"anyOf":[{"type":"object","properties":{"all":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["any"],"additionalProperties":false}]}},"required":["id","priority","select","when"],"additionalProperties":false}},"keep":{"default":{},"type":"object","properties":{"newest":{"type":"integer","minimum":0,"maximum":10000},"tagPatterns":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"semverLatest":{"type":"boolean"}},"additionalProperties":false},"softDeleteDays":{"default":7,"type":"integer","minimum":0,"maximum":30}},"required":["version","rules"],"additionalProperties":false,"description":"The default, in ews-lifecycle/v1 only (the AWS ECR format is accepted per repository, not here): {\"version\": \"ews-lifecycle/v1\", rules (at most 50), keep, softDeleteDays 1–30}. softDeleteDays 0 is refused with 400: a default always keeps expired images restorable for at least a day"},"mode":{"type":"string","enum":["active","preview","off"],"description":"active: the hourly run expires what the default selects in every inheriting repository; preview: it only reports; off: the default does nothing"}},"required":["policy","mode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutLifecyclePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/lifecycle-defaults/preview":{"post":{"operationId":"ecr.lifecycle-defaults.preview","summary":"What the default would expire across every inheriting repository, as if active","description":"`ecr:GetLifecyclePolicy` What the default would expire across every inheriting repository, as if active. A dry run, nothing changes. Without a body it runs the saved default; with {\"policy\": …} it runs that draft instead. `images` lists every image (the first 5,000; `totalImages` counts all) with `action`, `reason` and `by`, what decided it.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"description":"A draft default in ews-lifecycle/v1 to dry-run instead of the saved one. Omitted (or no body at all): the saved default, else the platform default","type":"object","properties":{"version":{"type":"string","const":"ews-lifecycle/v1"},"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"priority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"select":{"type":"object","properties":{"tagStatus":{"default":"any","type":"string","enum":["tagged","untagged","any"]},"tagPatterns":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"tagPrefixes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"namePrefix":{"type":"string","minLength":1,"maxLength":256},"prerelease":{"type":"boolean"}},"additionalProperties":false},"when":{"anyOf":[{"type":"object","properties":{"all":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["any"],"additionalProperties":false}]}},"required":["id","priority","select","when"],"additionalProperties":false}},"keep":{"default":{},"type":"object","properties":{"newest":{"type":"integer","minimum":0,"maximum":10000},"tagPatterns":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"semverLatest":{"type":"boolean"}},"additionalProperties":false},"softDeleteDays":{"default":7,"type":"integer","minimum":0,"maximum":30}},"required":["version","rules"],"additionalProperties":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/login-token":{"post":{"operationId":"ecr.auth.login-token","summary":"Mint a short-lived docker login token","description":"`ecr:GetAuthorizationToken` Mint a short-lived docker login token. Mints a 12-hour bearer credential for the whole org registry, so the IAM descriptor classifies GetAuthorizationToken as a write: the operation reports mutates: true and every issuance is audited. The answer carries the token id, which revokes it.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/login-tokens":{"get":{"operationId":"ecr.auth.list-login-tokens","summary":"List your own live login tokens (never their values)","description":"`ecr:GetAuthorizationToken` List your own live login tokens (never their values).","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/login-tokens/{id}":{"delete":{"operationId":"ecr.auth.revoke-login-token","summary":"Revoke one of your own login tokens; the registry refuses it at once","description":"`ecr:GetAuthorizationToken` Revoke one of your own login tokens; the registry refuses it at once.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Login token id, as minted or listed"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/pull-through-cache-rules":{"get":{"operationId":"ecr.pull-through-cache.list","summary":"List the pull-through cache rules","description":"`ecr:DescribePullThroughCacheRules` List the pull-through cache rules.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DescribePullThroughCacheRules","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ecr.pull-through-cache.create","summary":"Mirror an upstream registry under a prefix","description":"`ecr:CreatePullThroughCacheRule` Mirror an upstream registry under a prefix. Then `docker pull <org>.ecr.<root>/<prefix>/<name>:<tag>` fetches <name> from the upstream on first pull and serves it from this registry after that (Docker Hub official images: `<prefix>/node` = `library/node`). Tags are re-checked upstream after 6 hours; when upstream fails, the cached copy is served. Bringing new images in needs ecr:BatchImportUpstreamImage. upstreamRegistry: docker.io, ghcr.io, quay.io, registry.k8s.io, public.ecr.aws, mcr.microsoft.com. A login (username + passwordSecretId, a Deutsche Cloud Secret granted to the `registry` consumer) raises Docker Hub's anonymous pull limit and reaches private upstream images.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:\\/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$","description":"The path images are pulled under, e.g. dockerhub: <prefix>/<name> mirrors <name> upstream. 2–64 characters of lowercase path components (letters, digits, . _ - inside, / between). A prefix another rule has is refused with 409"},"upstreamRegistry":{"type":"string","enum":["docker.io","ghcr.io","quay.io","registry.k8s.io","public.ecr.aws","mcr.microsoft.com"],"description":"The registry mirrored: docker.io, ghcr.io, quay.io, registry.k8s.io, public.ecr.aws or mcr.microsoft.com"},"username":{"description":"Upstream user name, 1–255 characters; given together with passwordSecretId or not at all. Omitted: anonymous pulls","type":"string","minLength":1,"maxLength":255},"passwordSecretId":{"description":"Id of a Secret of this organization holding the upstream password or token, granted to the registry consumer; given together with username. An id that names no secret is refused with 400","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["prefix","upstreamRegistry"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:CreatePullThroughCacheRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/pull-through-cache-rules/{id}":{"patch":{"operationId":"ecr.pull-through-cache.update","summary":"Set or clear a rule's upstream login","description":"`ecr:UpdatePullThroughCacheRule` Set or clear a rule's upstream login.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Pull-through cache rule id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Upstream user name, 1–255 characters, or null to drop the login. Required, and null exactly when passwordSecretId is"},"passwordSecretId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Id of a Secret of this organization holding the password or token (granted to the registry consumer), or null to drop the login. Required, and null exactly when username is"}},"required":["username","passwordSecretId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:UpdatePullThroughCacheRule","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ecr.pull-through-cache.delete","summary":"Delete a rule (cached repositories stay, and stop refreshing)","description":"`ecr:DeletePullThroughCacheRule` Delete a rule (cached repositories stay, and stop refreshing).","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Pull-through cache rule id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeletePullThroughCacheRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/registry-aliases":{"get":{"operationId":"ecr.registry-aliases.get","summary":"List the registry aliases","description":"`ecr:DescribeRegistryAliases` List the registry aliases.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DescribeRegistryAliases","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"ecr.registry-aliases.put","summary":"Set the registry aliases (replaces the list)","description":"`ecr:PutRegistryAliases` Set the registry aliases (replaces the list). An alias { from: \"ghcr.io/acme\", to: \"acme\" } makes ghcr.io/acme/… in a workflow file this registry's acme/… and `docker login ghcr.io` this registry, in the job a runner receives. A job logs in with its GITHUB_TOKEN (packages: read pulls, write pushes and creates repositories inside the namespace). References in repository scripts, composite actions and Dockerfiles are not rewritten.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aliases":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The registry host and owner a workflow names, e.g. ghcr.io/acme"},"to":{"type":"string","description":"The namespace in this registry, e.g. acme: ghcr.io/acme/app becomes <registry>/acme/app"}},"required":["from","to"]},"description":"The whole list, at most 20: [{ \"from\": \"ghcr.io/acme\", \"to\": \"acme\" }]. from is host/owner; to is a namespace in this registry. Each from once; [] removes every alias"}},"required":["aliases"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutRegistryAliases","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories":{"get":{"operationId":"ecr.repositories.list","summary":"List repositories","description":"`ecr:DescribeRepositories` List repositories.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DescribeRepositories","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"ecr.repositories.create","summary":"Create a repository","description":"`ecr:CreateRepository` Create a repository. Public repositories serve anonymous pulls for their own images only; private is the default and is what a push creates.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":255,"pattern":"^[a-z0-9]+(?:(?:\\.|_|__|-+)[a-z0-9]+)*(?:\\/[a-z0-9]+(?:(?:\\.|_|__|-+)[a-z0-9]+)*)*$","description":"Repository name, unique in the organization: 2–255 characters of lowercase path components joined by / (team/api), each letters and digits joined by . _ __ or -. blobs, manifests, tags, referrers and uploads may not be a component. A taken name is refused with 409"},"description":{"description":"Free text shown with the repository, up to 256 characters; none when omitted","type":"string","maxLength":256},"visibility":{"description":"private: every pull needs a credential with ecr:PullImage. public: anyone can pull this repository’s images without credentials (read-only, and only the layers its own images reference). private when omitted","type":"string","enum":["private","public"]},"tagMutability":{"description":"immutable: a push that would move an existing tag to a different image is refused (re-pushing the same image is fine; deleting the tag is still allowed). mutable when omitted","type":"string","enum":["mutable","immutable"]},"tagMutabilityExclusions":{"description":"Up to 10 tag patterns (letters, digits, _ . - and * as a glob, 1–128 characters) that stay mutable in an immutable repository, e.g. [\"latest\", \"main-*\"]; none when omitted","maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*-]+$"}},"storageQuotaBytes":{"description":"Cap in bytes on every layer this repository holds, shared ones included: 1 MiB (1048576) to 1 PiB. null: no repository cap (the organization quota still applies). A push over it is refused; lowering it deletes nothing. No cap when omitted","anyOf":[{"type":"integer","minimum":1048576,"maximum":1125899906842624},{"type":"null"}]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:CreateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}":{"get":{"operationId":"ecr.repositories.get","summary":"Describe one repository","description":"`ecr:DescribeRepositories` Describe one repository.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DescribeRepositories","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"ecr.repositories.update","summary":"Change visibility, tag immutability or description","description":"`ecr:UpdateRepository` Change visibility, tag immutability or description. Only the fields given change. Public is reversible on purpose. tagMutability \"immutable\" refuses a push that would move an existing tag to a different image (re-pushing the same image is fine); tagMutabilityExclusions are * globs, e.g. [\"latest\"], that stay mutable.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"visibility":{"description":"private: every pull needs a credential with ecr:PullImage. public: anyone can pull this repository’s images without credentials (read-only, and only the layers its own images reference). Unchanged when omitted; public is reversible at any time","type":"string","enum":["private","public"]},"tagMutability":{"description":"immutable: a push that would move an existing tag to a different image is refused (re-pushing the same image is fine; deleting the tag is still allowed). Unchanged when omitted","type":"string","enum":["mutable","immutable"]},"tagMutabilityExclusions":{"description":"Up to 10 tag patterns (letters, digits, _ . - and * as a glob, 1–128 characters) that stay mutable in an immutable repository, e.g. [\"latest\", \"main-*\"]. Replaces the list; unchanged when omitted","maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*-]+$"}},"description":{"description":"Free text, up to 256 characters; null clears it; unchanged when omitted","anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"storageQuotaBytes":{"description":"Cap in bytes on every layer this repository holds, shared ones included: 1 MiB (1048576) to 1 PiB. null: no repository cap (the organization quota still applies). A push over it is refused; lowering it deletes nothing. Unchanged when omitted","anyOf":[{"type":"integer","minimum":1048576,"maximum":1125899906842624},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ecr.repositories.delete","summary":"Delete a repository","description":"`ecr:DeleteRepository` Delete a repository.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeleteRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/expired-images":{"get":{"operationId":"ecr.expired-images.list","summary":"List expired images with why, when they are purged, and whether something pulled them since","description":"`ecr:GetLifecyclePolicy` List expired images with why, when they are purged, and whether something pulled them since.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/expired-images/restore":{"post":{"operationId":"ecr.expired-images.restore","summary":"Bring an expired image back, with the tags nothing has taken since","description":"`ecr:RestoreExpiredItem` Bring an expired image back, with the tags nothing has taken since.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"digest":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$","description":"Digest of the expired image, sha256:<64 hex>, as the expired-image list gives it"}},"required":["digest"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:RestoreExpiredItem","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/images":{"get":{"operationId":"ecr.images.list","summary":"List images in a repository","description":"`ecr:ListImages` List images in a repository. Paged by manifest, newest first: `limit` (default 100, max 500) and `offset`. The response carries `hasMore`; one row per tag, plus one row with `tag: null` for an untagged manifest.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"limit","in":"query","required":false,"schema":{"default":100,"description":"Images (manifests) per page, 1–500; 100 when omitted. An image’s tags never span two pages","type":"integer","minimum":1,"maximum":500}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"description":"Images to skip, newest first, 0–1,000,000; 0 when omitted","type":"integer","minimum":0,"maximum":1000000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:ListImages","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/lifecycle-mode":{"put":{"operationId":"ecr.lifecycle-policy.set-mode","summary":"Inherit the organization default, or let nothing expire","description":"`ecr:PutLifecyclePolicy` Inherit the organization default, or let nothing expire. \"inherit\": the registry default applies; \"none\": nothing expires (an explicit choice).","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","enum":["inherit","none"],"description":"inherit: the organization’s registry default applies; none: nothing in this repository expires. A stored own policy is kept, unused, for a later PUT lifecycle-policy"}},"required":["mode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutLifecyclePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/lifecycle-policy":{"get":{"operationId":"ecr.lifecycle-policy.get","summary":"Read a repository's lifecycle policy","description":"`ecr:GetLifecyclePolicy` Read a repository's lifecycle policy.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"ecr.lifecycle-policy.put","summary":"Set the lifecycle policy","description":"`ecr:PutLifecyclePolicy` Set the lifecycle policy. {\"policy\": {\"rules\": [...]}} in the AWS ECR format; a policy written for ECR pastes in unchanged. Applied hourly. The response lists what it would expire right now (wouldExpire) — the next run expires exactly that. Expired images stay restorable for softDeleteDays (7 for an AWS ECR policy) before they are purged.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"ews-lifecycle/v1"},"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"priority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"select":{"type":"object","properties":{"tagStatus":{"default":"any","type":"string","enum":["tagged","untagged","any"]},"tagPatterns":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"tagPrefixes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"namePrefix":{"type":"string","minLength":1,"maxLength":256},"prerelease":{"type":"boolean"}},"additionalProperties":false},"when":{"anyOf":[{"type":"object","properties":{"all":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["any"],"additionalProperties":false}]}},"required":["id","priority","select","when"],"additionalProperties":false}},"keep":{"default":{},"type":"object","properties":{"newest":{"type":"integer","minimum":0,"maximum":10000},"tagPatterns":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"semverLatest":{"type":"boolean"}},"additionalProperties":false},"softDeleteDays":{"default":7,"type":"integer","minimum":0,"maximum":30}},"required":["version","rules"],"additionalProperties":false},{"type":"object","properties":{"rules":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"rulePriority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"selection":{"type":"object","properties":{"tagStatus":{"type":"string","enum":["tagged","untagged","any"]},"tagPatternList":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*-]+$"}},"tagPrefixList":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.-]+$"}},"countType":{"type":"string","enum":["imageCountMoreThan","sinceImagePushed"]},"countUnit":{"type":"string","const":"days"},"countNumber":{"type":"integer","minimum":1,"maximum":100000}},"required":["tagStatus","countType","countNumber"]},"action":{"default":{"type":"expire"},"type":"object","properties":{"type":{"type":"string","const":"expire"}},"required":["type"]}},"required":["rulePriority","selection"]}}},"required":["rules"]}],"description":"The policy: AWS ECR lifecycle JSON ({\"rules\": [{rulePriority, selection, action}]}, at most 50 rules; expired images stay restorable for 7 days) or ews-lifecycle/v1 ({\"version\": \"ews-lifecycle/v1\", rules, keep, softDeleteDays 0–30, default 7}). Stored as given, and the repository switches to its own policy"}},"required":["policy"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutLifecyclePolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ecr.lifecycle-policy.delete","summary":"Remove the lifecycle policy","description":"`ecr:DeleteLifecyclePolicy` Remove the lifecycle policy.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeleteLifecyclePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/lifecycle-policy/preview":{"post":{"operationId":"ecr.lifecycle-policy.preview","summary":"Which images a policy would expire now","description":"`ecr:GetLifecyclePolicy` Which images a policy would expire now. The stored policy, or {\"policy\": …} to try one before saving it. Changes nothing. Answers per rule what it would expire (count, bytes) and per image the decision and why (a protection such as in-use, a keep clause, or the rule).","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"description":"A policy to try before saving it (AWS ECR JSON or ews-lifecycle/v1), previewed as if saved and active. Omitted: the policy that applies to the repository now","anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"ews-lifecycle/v1"},"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"priority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"select":{"type":"object","properties":{"tagStatus":{"default":"any","type":"string","enum":["tagged","untagged","any"]},"tagPatterns":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"tagPrefixes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"namePrefix":{"type":"string","minLength":1,"maxLength":256},"prerelease":{"type":"boolean"}},"additionalProperties":false},"when":{"anyOf":[{"type":"object","properties":{"all":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["any"],"additionalProperties":false}]}},"required":["id","priority","select","when"],"additionalProperties":false}},"keep":{"default":{},"type":"object","properties":{"newest":{"type":"integer","minimum":0,"maximum":10000},"tagPatterns":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"semverLatest":{"type":"boolean"}},"additionalProperties":false},"softDeleteDays":{"default":7,"type":"integer","minimum":0,"maximum":30}},"required":["version","rules"],"additionalProperties":false},{"type":"object","properties":{"rules":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"rulePriority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"selection":{"type":"object","properties":{"tagStatus":{"type":"string","enum":["tagged","untagged","any"]},"tagPatternList":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*-]+$"}},"tagPrefixList":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.-]+$"}},"countType":{"type":"string","enum":["imageCountMoreThan","sinceImagePushed"]},"countUnit":{"type":"string","const":"days"},"countNumber":{"type":"integer","minimum":1,"maximum":100000}},"required":["tagStatus","countType","countNumber"]},"action":{"default":{"type":"expire"},"type":"object","properties":{"type":{"type":"string","const":"expire"}},"required":["type"]}},"required":["rulePriority","selection"]}}},"required":["rules"]}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/manifests/{manifestId}":{"delete":{"operationId":"ecr.images.delete-untagged","summary":"Delete an image that no tag points at","description":"`ecr:DeleteImage` Delete an image that no tag points at. Refuses with 409 while any tag still points at the manifest, naming them — delete the tag instead, and the image goes with the last one. The digest is returned so a script can log what it removed.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"manifestId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Image (manifest) id, a UUID: `manifest.id` of a row in the image list"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeleteImage","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{id}/tags/{tag}":{"delete":{"operationId":"ecr.images.delete-tag","summary":"Delete a tag from a repository","description":"`ecr:DeleteImage` Delete a tag from a repository.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"tag","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"description":"The tag name, 1–128 characters, e.g. v1.2.0"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeleteImage","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/repositories/{repoId}/images/{manifestId}/scan":{"post":{"operationId":"ecr.images.scan","summary":"Trigger a vulnerability scan on an image","description":"`ecr:ScanImage` Trigger a vulnerability scan on an image.","tags":["Container registry"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"manifestId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Image (manifest) id, a UUID: `manifest.id` of a row in the image list"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:ScanImage","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"ecr.images.latest-scan","summary":"Show the most recent scan for an image","description":"`ecr:GetScanResults` Show the most recent scan for an image.","tags":["Container registry"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"manifestId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Image (manifest) id, a UUID: `manifest.id` of a row in the image list"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetScanResults","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/repositories/{repoId}/images/{manifestId}/scans":{"get":{"operationId":"ecr.images.list-scans","summary":"List the scans recorded for an image","description":"`ecr:GetScanResults` List the scans recorded for an image. Newest first, without findings: `limit` (default 50, max 200) and `offset`; the response carries `hasMore`. Fetch one scan for its findings.","tags":["Container registry"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"manifestId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Image (manifest) id, a UUID: `manifest.id` of a row in the image list"}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"description":"Scans per page, 1–200; 50 when omitted","type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"description":"Scans to skip, newest first, 0–1,000,000; 0 when omitted","type":"integer","minimum":0,"maximum":1000000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetScanResults","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/repositories/{repoId}/images/{manifestId}/signatures":{"get":{"operationId":"ecr.signing.verify","summary":"Verify an image's signatures against the trusted keys","description":"`ecr:DescribeImageSignatures` Verify an image's signatures against the trusted keys. status: signed (a trusted key verifies a signature), untrusted (signatures, none trusted), unsigned. Each signature: format (cosign-bundle, cosign-simplesigning, notation-jws), status (verified, untrusted, invalid, unsupported — keyless cosign and COSE notation), the key that verified it and why not. deployable says whether the policy would let it deploy.","tags":["Container registry"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Repository id (a UUID)"}},{"name":"manifestId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Image (manifest) id, a UUID: `manifest.id` of a row in the image list"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DescribeImageSignatures","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/scan-results/{scanId}":{"get":{"operationId":"ecr.scan-results.get","summary":"Fetch the findings of one scan","description":"`ecr:GetScanResults` Fetch the findings of one scan.","tags":["Container registry"],"parameters":[{"name":"scanId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Scan id, from the scan or scan-list answer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetScanResults","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/signing-keys":{"post":{"operationId":"ecr.signing.add-key","summary":"Trust a cosign public key or a notation certificate","description":"`ecr:CreateSigningKey` Trust a cosign public key or a notation certificate. kind \"cosign\": the PEM public key (cosign.pub; ECDSA, RSA ≥ 2048 or Ed25519). kind \"notation\": PEM certificate(s) — a root, an intermediate or the signing certificate — that a signature's chain must reach. repositoryPattern (* globs, default \"*\") limits which repositories the key may vouch for.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._-]*$","description":"A name for the key, unique in the organization: 1–64 letters, digits, space, . _ - (starting with a letter or digit)"},"kind":{"type":"string","enum":["cosign","notation"],"description":"cosign: a cosign public key; notation: a Notary Project (notation) certificate"},"pem":{"type":"string","minLength":1,"maxLength":65536,"description":"PEM text, up to 64 KiB. cosign: the public key (cosign.pub; ECDSA, RSA of at least 2048 bits or Ed25519). notation: one or more certificates (a root, an intermediate or the signing certificate) a signature’s chain must reach. Material that does not parse as that kind is refused with 400"},"repositoryPattern":{"description":"Which repositories the key may vouch for: a repository name with * globs (team/*), 1–255 characters; * (every repository) when omitted","type":"string","minLength":1,"maxLength":255,"pattern":"^[a-z0-9._/*-]+$"}},"required":["name","kind","pem"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:CreateSigningKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/signing-keys/{id}":{"delete":{"operationId":"ecr.signing.delete-key","summary":"Stop trusting a signing key","description":"`ecr:DeleteSigningKey` Stop trusting a signing key.","tags":["Container registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Signing key id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:DeleteSigningKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/signing-policy":{"get":{"operationId":"ecr.signing.get-policy","summary":"Show the signing policy and the trusted keys","description":"`ecr:GetSigningPolicy` Show the signing policy and the trusted keys.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetSigningPolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"ecr.signing.put-policy","summary":"Turn \"only signed images deploy\" on or off","description":"`ecr:PutSigningPolicy` Turn \"only signed images deploy\" on or off. {\"requireSignedImages\": true} makes the deploy service refuse an image from the registry that no trusted key signed, and every image from another registry. Images Deutsche Cloud builds from source pass by provenance. New deployments only — running apps keep running.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requireSignedImages":{"type":"boolean","description":"true: a new deployment is refused unless a trusted key signed its image (images built from source pass by provenance; images from another registry are refused). false: signatures are shown, nothing is refused. Running apps are not affected either way"}},"required":["requireSignedImages"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutSigningPolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ecr.signing.delete-policy","summary":"Turn the signing policy off (trusted keys stay)","description":"`ecr:PutSigningPolicy` Turn the signing policy off (trusted keys stay).","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutSigningPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/ecr/api/storage":{"get":{"operationId":"ecr.storage.get","summary":"Show storage used per repository against the quotas","description":"`ecr:GetRegistryStorage` Show storage used per repository against the quotas. usedBytes counts each stored layer once (deduplicated across repositories) and is exactly breakdown.inRepositoriesBytes + pendingPurgeBytes (held only by expired, restorable images; the first is purged at nextPurgeAt) + unreferencedBytes (no image holds them; cleanup deletes them 24 h later when cleanup.mode is delete, and keeps them when it is report). quotaUsedBytes = inRepositoriesBytes is what the quota counts. A repository's usedBytes counts every layer it holds; sharedBytes is the part other repositories hold too. effectiveQuotaBytes is the lower of the organization's quota and the platform's.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:GetRegistryStorage","x-ews-mutates":false,"x-ews-sensitive":false}},"/ecr/api/storage-quota":{"put":{"operationId":"ecr.storage.put-quota","summary":"Set the organization's storage quota","description":"`ecr:PutRegistryStorageQuota` Set the organization's storage quota. A push (or pull-through fill) that would store more is refused with DENIED and the numbers; a layer already stored always passes. A repository has its own storageQuotaBytes (PATCH /ecr/api/repositories/{id}). Lowering a quota deletes nothing.","tags":["Container registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quotaBytes":{"anyOf":[{"type":"integer","minimum":1048576,"maximum":1125899906842624},{"type":"null"}],"description":"Cap in bytes on the layers in the organization’s repositories, each counted once: 1 MiB (1048576) to 1 PiB. null removes it. Required. A push over it is refused; lowering it deletes nothing. The platform quota applies too, whichever is lower"}},"required":["quotaBytes"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutRegistryStorageQuota","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"ecr.storage.delete-quota","summary":"Remove the organization's storage quota","description":"`ecr:PutRegistryStorageQuota` Remove the organization's storage quota.","tags":["Container registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ecr:PutRegistryStorageQuota","x-ews-mutates":true,"x-ews-sensitive":false}},"/efs/api/file-systems":{"get":{"operationId":"efs.file-systems.list","summary":"List file systems with their mount address and usage","description":"`efs:DescribeFileSystems` List file systems with their mount address and usage.","tags":["File Storage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DescribeFileSystems","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"efs.file-systems.create","summary":"Create a file system","description":"`efs:CreateFileSystem` Create a file system. name, sizeGib (10–10240), availabilityZoneId (default the region’s default zone), vpcId (default VPC), nodeType (performance-2|performance-4|performance-8; the provider’s own type names are still accepted, deprecated), kmsKeyId. Always encrypted (LUKS2). Status creating → available in a few minutes; mount <mountAddress>:/ over NFSv4.2 from anywhere in the VPC.","tags":["File Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"sizeGib":{"type":"integer","minimum":10,"maximum":10240},"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"availabilityZoneId":{"type":"string","minLength":1,"maxLength":32},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"nodeType":{"default":"performance-2","description":"The serving machine’s instance type: performance-2 (default), performance-4 or performance-8. The provider’s own type names are still accepted, deprecated.","type":"string","enum":["performance-2","performance-4","performance-8","cpx22","cpx32","cpx42"]},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","sizeGib"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:CreateFileSystem","x-ews-mutates":true,"x-ews-sensitive":false}},"/efs/api/file-systems/{id}":{"get":{"operationId":"efs.file-systems.get","summary":"One file system: status, size, usage, mount command and fstab line","description":"`efs:DescribeFileSystems` One file system: status, size, usage, mount command and fstab line.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DescribeFileSystems","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"efs.file-systems.update","summary":"Grow a file system online (it never shrinks)","description":"`efs:UpdateFileSystem` Grow a file system online (it never shrinks).","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sizeGib":{"type":"integer","minimum":10,"maximum":10240}},"required":["sizeGib"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:UpdateFileSystem","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"efs.file-systems.delete","summary":"Delete a file system with every file and snapshot in it","description":"`efs:DeleteFileSystem` Delete a file system with every file and snapshot in it. Its volume key is destroyed with it: the blocks are unreadable from then on.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DeleteFileSystem","x-ews-mutates":true,"x-ews-sensitive":false}},"/efs/api/file-systems/{id}/events":{"get":{"operationId":"efs.file-systems.events","summary":"What happened to the file system and on its machine","description":"`efs:DescribeFileSystems` What happened to the file system and on its machine.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DescribeFileSystems","x-ews-mutates":false,"x-ews-sensitive":false}},"/efs/api/file-systems/{id}/snapshots":{"get":{"operationId":"efs.snapshots.list","summary":"List a file system’s snapshots","description":"`efs:DescribeSnapshots` List a file system’s snapshots.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DescribeSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"efs.snapshots.create","summary":"Take a snapshot (available within about 15 seconds)","description":"`efs:CreateSnapshot` Take a snapshot (available within about 15 seconds). Instant and space-sharing (LVM thin). Refused while the volume is 80 % full; at 90 % the oldest snapshot is removed and the activity feed says so.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,39}$"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:CreateSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/efs/api/file-systems/{id}/snapshots/{snapshot}":{"delete":{"operationId":"efs.snapshots.delete","summary":"Delete a snapshot","description":"`efs:DeleteSnapshot` Delete a snapshot.","tags":["File Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^fs-[0-9a-f]{12}$","description":"File system id (fs-…)"}},{"name":"snapshot","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,39}$","description":"The name the snapshot was taken under"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"efs:DeleteSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/addon-versions":{"get":{"operationId":"eks.addon-versions.list","summary":"List add-ons, their versions and the Kubernetes minors each supports","description":"`eks:DescribeAddonVersions` List add-ons, their versions and the Kubernetes minors each supports.","tags":["Kubernetes"],"parameters":[{"name":"kubernetesVersion","in":"query","required":false,"schema":{"description":"Only versions that support this Kubernetes minor","type":"string","enum":["1.36","1.37"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeAddonVersions","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/clusters":{"get":{"operationId":"eks.clusters.list","summary":"List clusters","description":"`eks:ListClusters` List clusters.","tags":["Kubernetes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.clusters.create","summary":"Create a cluster","description":"`eks:CreateCluster` Create a cluster. tier dev runs one control-plane machine, standard three. The creator gets a ClusterAdmin access entry. nodegroup creates a first node group once the control plane is up and also needs eks:CreateNodegroup (and iam:PassRole when nodeRole is set). 409 when the name is taken.","tags":["Kubernetes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"name":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,38}[a-z0-9])?$","description":"Cluster name, unique in the organization (409 when taken): lowercase letters, digits and hyphens, starting with a letter, at most 40 characters"},"version":{"description":"Kubernetes minor; default the regular channel","type":"string","enum":["1.36","1.37"]},"tier":{"description":"dev: one control-plane machine, no SLA. standard: three, highly available","type":"string","enum":["dev","standard"]},"vpcId":{"description":"VPC the node groups join; default VPC if unset","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"allowedCidrs":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"cidrv4","pattern":"^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\/([0-9]|[1-2][0-9]|3[0-2])$"},"description":"CIDRs allowed to reach the public endpoint, e.g. [\"203.0.113.0/24\"]"},"endpointPublicAccess":{"description":"The endpoint answers on its public address (to allowedCidrs); default true","type":"boolean"},"endpointPrivateAccess":{"description":"The endpoint answers inside the VPC; default true","type":"boolean"},"deletionProtection":{"description":"true: a delete is refused (409) until it is turned off. Default false","type":"boolean"},"nodegroup":{"description":"A first node group, created once the control plane is up","type":"object","properties":{"name":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name, unique in the cluster (409 when taken): lowercase letters, digits and hyphens, starting with a letter, at most 32 characters"},"drainTimeoutMinutes":{"description":"Upgrades: minutes a node’s drain may wait on PodDisruptionBudgets; default 60","type":"integer","minimum":5,"maximum":1440},"forceAfterTimeout":{"description":"Upgrades: after the timeout, remove the node anyway (true) or pause the upgrade (false, default)","type":"boolean"},"autoscaling":{"description":"Let the cluster autoscaler change desiredSize between minSize and maxSize (pending pods grow the group, underused nodes shrink it)","type":"boolean"},"zones":{"description":"Availability zones the nodes spread over, balanced (e.g. [\"de1a\",\"de1b\"]); default the region’s default zone. Applies to nodes created from then on","maxItems":4,"type":"array","items":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"}},"instanceTypes":{"description":"Instance types to buy, in order, when instanceType is sold out in a zone (same CPU architecture), e.g. performance-8","maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z0-9-]{2,24}$"}},"capacityFallback":{"description":"Stock fallback; default off. otherZones: zones outside `zones` may be used; equivalentTypes: an equivalent server type may be bought","type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"]},"instanceType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type, e.g. performance-4. The provider’s own type names are still accepted, deprecated."},"labels":{"description":"Kubernetes labels on every node, e.g. {\"workload\":\"web\"}; at most 20. kubernetes.io/, k8s.io/ and eks.ews.cloud/ keys are refused (400). Default none","type":"object","propertyNames":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"additionalProperties":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"}},"taints":{"description":"Kubernetes taints on every node: { key, value?, effect: NoSchedule | PreferNoSchedule | NoExecute }; at most 10. Default none","maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"value":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"},"effect":{"type":"string","enum":["NoSchedule","PreferNoSchedule","NoExecute"]}},"required":["key","effect"]}},"nodeRole":{"description":"Name of an IAM role the nodes act as; needs iam:PassRole on it","type":"string","minLength":1,"maxLength":128},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"minSize":{"type":"integer","minimum":0,"maximum":100,"description":"Fewest nodes, 0–100; the cluster autoscaler never goes below it. minSize ≤ desiredSize ≤ maxSize, else 400"},"desiredSize":{"type":"integer","minimum":0,"maximum":100,"description":"Nodes to run now, 0–100; with autoscaling on, the cluster autoscaler changes it between minSize and maxSize"},"maxSize":{"type":"integer","minimum":1,"maximum":100,"description":"Most nodes, 1–100; what the quotas count (nodes per node group, and nodes per cluster summed over its node groups; 20 and 50 by default): 409 QuotaExceeded above them"}},"required":["name","instanceType","minSize","desiredSize","maxSize"]},"addons":{"description":"Add-ons to install. Default: metrics-server. [] installs none","maxItems":8,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["metrics-server","traefik","cert-manager","external-dns"],"description":"metrics-server, traefik, cert-manager or external-dns"},"version":{"description":"Default: the newest that supports the cluster’s Kubernetes","type":"string","maxLength":32},"config":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"The add-on’s options. traefik: replicas, proxyProtocol, loadBalancerType, defaultIngressClass. cert-manager: zones, email. external-dns: zones (required), policy, sources. metrics-server: none"}},"required":["name"]}},"logging":{"description":"Default: audit only","type":"object","properties":{"types":{"maxItems":5,"type":"array","items":{"type":"string","enum":["api","audit","authenticator","controllerManager","scheduler"]}}},"required":["types"]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreateCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}":{"get":{"operationId":"eks.clusters.get","summary":"One cluster: endpoint, version, status, control-plane readiness","description":"`eks:DescribeCluster` One cluster: endpoint, version, status, control-plane readiness.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeCluster","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"eks.clusters.update","summary":"Change the networks allowed to reach the API endpoint, or deletion protection","description":"`eks:UpdateClusterConfig` Change the networks allowed to reach the API endpoint, or deletion protection.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedCidrs":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"cidrv4","pattern":"^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\/([0-9]|[1-2][0-9]|3[0-2])$"},"description":"CIDRs allowed to reach the public endpoint, e.g. [\"203.0.113.0/24\"]"},"endpointPublicAccess":{"description":"The endpoint answers on its public address (to allowedCidrs); default true","type":"boolean"},"endpointPrivateAccess":{"description":"The endpoint answers inside the VPC; default true","type":"boolean"},"deletionProtection":{"description":"true: a delete is refused (409) until it is turned off. Unchanged when absent","type":"boolean"},"autoscaler":{"description":"The cluster autoscaler’s settings; it acts on node groups with autoscaling on","type":"object","properties":{"scaleDownUtilizationThreshold":{"description":"A node whose pods request less than this share of CPU and memory may go; default 0.5","type":"number","minimum":0.1,"maximum":0.9},"scaleDownUnneededMinutes":{"description":"Minutes a node must be unneeded before it goes; default 10","type":"integer","minimum":1,"maximum":120},"expander":{"description":"Which group grows when several could; default least-waste","type":"string","enum":["least-waste","random","most-pods"]}},"additionalProperties":false},"logging":{"type":"object","properties":{"types":{"maxItems":5,"type":"array","items":{"type":"string","enum":["api","audit","authenticator","controllerManager","scheduler"]}}},"required":["types"],"description":"Control-plane log types shipped to monitoring: api, audit, authenticator, controllerManager, scheduler"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateClusterConfig","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"eks.clusters.delete","summary":"Delete a cluster, its control plane, node groups and nodes","description":"`eks:DeleteCluster` Delete a cluster, its control plane, node groups and nodes. 409 while deletion protection is on. By default a final etcd snapshot is taken and the cluster can be restored for 7 days (`deleted-clusters restore`): its settings, key material and PersistentVolumes’ volumes are kept, detached and free. `permanent=true` keeps nothing.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"permanent","in":"query","required":false,"schema":{"description":"true: nothing is kept (no final snapshot, volumes deleted), the cluster cannot be restored. Default: restorable for 7 days","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeleteCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/access-entries":{"get":{"operationId":"eks.access-entries.list","summary":"List a cluster’s access entries and their access policies","description":"`eks:ListAccessEntries` List a cluster’s access entries and their access policies.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListAccessEntries","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.access-entries.create","summary":"Give an IAM user, group or role an access entry","description":"`eks:CreateAccessEntry` Give an IAM user, group or role an access entry. policies associates access policies at once and also needs eks:AssociateAccessPolicy. A person also needs eks:AccessKubernetesApi in IAM to get a token.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"principalType":{"type":"string","enum":["user","group","role"],"description":"What `principal` names: user, group or role (IAM)"},"principal":{"type":"string","minLength":1,"maxLength":128,"description":"The IAM user name, group name or role name; 404 when none has it, 409 when it already has an entry on the cluster"},"username":{"description":"Kubernetes username the entry’s tokens carry, prefixed ews: by the cluster (RBAC sees ews:<username>); 1–100 letters, digits and : . _ @ -, not starting system:. Default: the IAM user name of whoever gets the token","type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._@-]*$"},"kubernetesGroups":{"description":"Extra Kubernetes groups the entry’s tokens carry, for your own RBAC bindings; at most 20, each 1–100 letters, digits and : . _ @ -, not starting system: or ews:. Default none","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._@-]*$"}},"policies":{"description":"Access policies to associate at once","maxItems":4,"type":"array","items":{"type":"object","properties":{"policy":{"type":"string","enum":["ClusterAdmin","Admin","Edit","View"]},"namespaces":{"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"}}},"required":["policy"]}}},"required":["principalType","principal"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreateAccessEntry","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/access-entries/{id}":{"get":{"operationId":"eks.access-entries.get","summary":"One access entry and its access policies","description":"`eks:DescribeAccessEntry` One access entry and its access policies.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access entry id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeAccessEntry","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"eks.access-entries.update","summary":"Change an access entry’s Kubernetes username or extra groups","description":"`eks:UpdateAccessEntry` Change an access entry’s Kubernetes username or extra groups.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access entry id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"description":"Kubernetes username the entry’s tokens carry, prefixed ews: by the cluster (RBAC sees ews:<username>); 1–100 letters, digits and : . _ @ -, not starting system:. null clears it (tokens then carry the IAM user name of whoever gets them); unchanged when absent","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._@-]*$"},{"type":"null"}]},"kubernetesGroups":{"description":"Extra Kubernetes groups the entry’s tokens carry, for your own RBAC bindings; at most 20, each 1–100 letters, digits and : . _ @ -, not starting system: or ews:. Replaces the list; [] clears it; unchanged when absent","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9:._@-]*$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateAccessEntry","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"eks.access-entries.delete","summary":"Remove an access entry","description":"`eks:DeleteAccessEntry` Remove an access entry.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access entry id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeleteAccessEntry","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/access-entries/{id}/policies":{"post":{"operationId":"eks.access-entries.associate-policy","summary":"Grant an access entry an access policy, cluster-wide or in namespaces","description":"`eks:AssociateAccessPolicy` Grant an access entry an access policy, cluster-wide or in namespaces. Associating a policy again replaces its namespaces.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access entry id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"string","enum":["ClusterAdmin","Admin","Edit","View"],"description":"ClusterAdmin (cluster-admin), Admin (admin), Edit (edit) or View (view): the Kubernetes ClusterRole it binds"},"namespaces":{"description":"Namespaces it applies in; cluster-wide when empty. ClusterAdmin is always cluster-wide","maxItems":20,"type":"array","items":{"type":"string","pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"}}},"required":["policy"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:AssociateAccessPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/access-entries/{id}/policies/{policy}":{"delete":{"operationId":"eks.access-entries.disassociate-policy","summary":"Remove an access policy from an access entry","description":"`eks:DisassociateAccessPolicy` Remove an access policy from an access entry.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access entry id"}},{"name":"policy","in":"path","required":true,"schema":{"type":"string","enum":["ClusterAdmin","Admin","Edit","View"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DisassociateAccessPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/addons":{"get":{"operationId":"eks.addons.list","summary":"List a cluster’s add-ons, with the system components Deutsche Cloud runs (system: true)","description":"`eks:ListAddons` List a cluster’s add-ons, with the system components Deutsche Cloud runs (system: true).","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListAddons","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.addons.create","summary":"Install a managed add-on","description":"`eks:CreateAddon` Install a managed add-on. The DNS add-ons (external-dns, cert-manager with zones) also need dns:ChangeRecords on every zone they list: the cluster may then change records there, without any stored credential. 409 when the cluster already has it.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","enum":["metrics-server","traefik","cert-manager","external-dns"],"description":"metrics-server, traefik, cert-manager or external-dns"},"version":{"description":"Default: the newest that supports the cluster’s Kubernetes","type":"string","maxLength":32},"config":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"The add-on’s options. traefik: replicas, proxyProtocol, loadBalancerType, defaultIngressClass. cert-manager: zones, email. external-dns: zones (required), policy, sources. metrics-server: none"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreateAddon","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/addons/{name}":{"get":{"operationId":"eks.addons.get","summary":"One add-on: version, options, status, workloads ready, upgrade available","description":"`eks:DescribeAddon` One add-on: version, options, status, workloads ready, upgrade available.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","enum":["metrics-server","traefik","cert-manager","external-dns"],"description":"metrics-server, traefik, cert-manager or external-dns"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeAddon","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"eks.addons.update","summary":"Change an add-on’s version or options","description":"`eks:UpdateAddon` Change an add-on’s version or options. Versions come from `addon-versions list`; upgrades are never automatic. A cluster upgrade is refused while an add-on’s version does not support the next Kubernetes minor.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","enum":["metrics-server","traefik","cert-manager","external-dns"],"description":"metrics-server, traefik, cert-manager or external-dns"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"description":"Another version from DescribeAddonVersions","type":"string","maxLength":32},"config":{"description":"Replaces the options as a whole","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateAddon","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"eks.addons.delete","summary":"Remove an add-on","description":"`eks:DeleteAddon` Remove an add-on. Its workloads and EWS-made objects go; its CRDs and your resources of them (Certificates, IngressRoutes) stay.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","enum":["metrics-server","traefik","cert-manager","external-dns"],"description":"metrics-server, traefik, cert-manager or external-dns"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeleteAddon","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/admin-credentials":{"post":{"operationId":"eks.clusters.admin-credentials","summary":"Break glass: a one-hour cluster-admin client certificate","description":"`eks:GetClusterAdminCredentials` Break glass: a one-hour cluster-admin client certificate. For when Deutsche Cloud sign-in or RBAC is broken. Cannot be revoked, so it lasts an hour; every issuance is in the audit log and on the cluster’s Activity.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:GetClusterAdminCredentials","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/availability":{"get":{"operationId":"eks.clusters.availability","summary":"The month’s measured API availability, SLA result and credit, each unavailable minute and which measurement saw it, and the outside probes","description":"`eks:DescribeCluster` The month’s measured API availability, SLA result and credit, each unavailable minute and which measurement saw it, and the outside probes. A minute is unavailable when no control-plane machine reported a serving API (agent), or a strict majority (at least two) of Deutsche Cloud’s outside probe locations failed `GET /readyz` (outside). A minute with no machine report at all while at least two outside locations all got answers is Deutsche Cloud’s blind spot: listed with source `ews-blind-spot`, counted as available (`blindSpotMinutes`). `probes` is the last decided minute per location; `platformAddresses` are the addresses those requests come from, let through the endpoint while it is public.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"month","in":"query","required":false,"schema":{"description":"YYYY-MM (UTC); default: this month","type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeCluster","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/events":{"get":{"operationId":"eks.clusters.events","summary":"The cluster’s activity: provisioning steps, changes, control-plane reports","description":"`eks:DescribeCluster` The cluster’s activity: provisioning steps, changes, control-plane reports.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"since","in":"query","required":false,"schema":{"description":"Only events strictly after this ISO time (for polling). Default: from the first","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many events, oldest first, 1–500; default 200","type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeCluster","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/forced-upgrade/postpone":{"post":{"operationId":"eks.clusters.postpone-upgrade","summary":"Postpone Deutsche Cloud’s control-plane upgrade after end of support, once, by 14 days","description":"`eks:PostponeClusterUpgrade` Postpone Deutsche Cloud’s control-plane upgrade after end of support, once, by 14 days. Thirty days after a minor’s end of support Deutsche Cloud upgrades the control plane one minor, on a Tuesday–Thursday at 10:00 Berlin time announced at least seven days ahead (`forcedUpgrade` on the cluster). Once announced and until it starts, the owners may move it 14 days later, once; a second move goes through Deutsche Cloud support. 409 when none is scheduled, it was postponed already, or it has started.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:PostponeClusterUpgrade","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/kubeconfig":{"get":{"operationId":"eks.clusters.kubeconfig","summary":"The endpoint and CA a kubeconfig entry needs","description":"`eks:DescribeCluster` The endpoint and CA a kubeconfig entry needs. `dcloud eks update-kubeconfig` writes the entry from this, with `dcloud eks get-token` as its exec plugin.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeCluster","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/logs":{"get":{"operationId":"eks.clusters.logs","summary":"Control-plane logs: the Kubernetes audit log, API server, authenticator, controller manager, scheduler","description":"`eks:GetClusterLogs` Control-plane logs: the Kubernetes audit log, API server, authenticator, controller manager, scheduler. Kept 7 days. Only the types turned on in the cluster’s logging (audit by default; change it with `clusters update --logging`) are collected. The audit log leaves out reads by the cluster’s own components that succeeded; every write, every refusal and every request by a person or a workload is in it.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"type","in":"query","required":false,"schema":{"description":"Only this log type: api, audit, authenticator, controllerManager or scheduler. Default: every type","type":"string","enum":["api","audit","authenticator","controllerManager","scheduler"]}},{"name":"since","in":"query","required":false,"schema":{"description":"ISO time, inclusive. Default: one hour before `until`","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"until","in":"query","required":false,"schema":{"description":"ISO time, inclusive. Default: now","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"contains","in":"query","required":false,"schema":{"description":"Only lines whose message contains this text, ignoring case; at most 200 characters","type":"string","maxLength":200}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many lines, newest first, 1–1000; default 200","type":"integer","minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:GetClusterLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/nodegroups":{"get":{"operationId":"eks.nodegroups.list","summary":"List a cluster’s node groups with their nodes","description":"`eks:ListNodegroups` List a cluster’s node groups with their nodes.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListNodegroups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.nodegroups.create","summary":"Add a node group","description":"`eks:CreateNodegroup` Add a node group. The nodes run the cluster’s Kubernetes version and appear in Compute, locked to the node group. nodeRole needs iam:PassRole on that role.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name, unique in the cluster (409 when taken): lowercase letters, digits and hyphens, starting with a letter, at most 32 characters"},"drainTimeoutMinutes":{"description":"Upgrades: minutes a node’s drain may wait on PodDisruptionBudgets; default 60","type":"integer","minimum":5,"maximum":1440},"forceAfterTimeout":{"description":"Upgrades: after the timeout, remove the node anyway (true) or pause the upgrade (false, default)","type":"boolean"},"autoscaling":{"description":"Let the cluster autoscaler change desiredSize between minSize and maxSize (pending pods grow the group, underused nodes shrink it)","type":"boolean"},"zones":{"description":"Availability zones the nodes spread over, balanced (e.g. [\"de1a\",\"de1b\"]); default the region’s default zone. Applies to nodes created from then on","maxItems":4,"type":"array","items":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"}},"instanceTypes":{"description":"Instance types to buy, in order, when instanceType is sold out in a zone (same CPU architecture), e.g. performance-8","maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z0-9-]{2,24}$"}},"capacityFallback":{"description":"Stock fallback; default off. otherZones: zones outside `zones` may be used; equivalentTypes: an equivalent server type may be bought","type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"]},"instanceType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type, e.g. performance-4. The provider’s own type names are still accepted, deprecated."},"labels":{"description":"Kubernetes labels on every node, e.g. {\"workload\":\"web\"}; at most 20. kubernetes.io/, k8s.io/ and eks.ews.cloud/ keys are refused (400). Default none","type":"object","propertyNames":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"additionalProperties":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"}},"taints":{"description":"Kubernetes taints on every node: { key, value?, effect: NoSchedule | PreferNoSchedule | NoExecute }; at most 10. Default none","maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"value":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"},"effect":{"type":"string","enum":["NoSchedule","PreferNoSchedule","NoExecute"]}},"required":["key","effect"]}},"nodeRole":{"description":"Name of an IAM role the nodes act as; needs iam:PassRole on it","type":"string","minLength":1,"maxLength":128},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"minSize":{"type":"integer","minimum":0,"maximum":100,"description":"Fewest nodes, 0–100; the cluster autoscaler never goes below it. minSize ≤ desiredSize ≤ maxSize, else 400"},"desiredSize":{"type":"integer","minimum":0,"maximum":100,"description":"Nodes to run now, 0–100; with autoscaling on, the cluster autoscaler changes it between minSize and maxSize"},"maxSize":{"type":"integer","minimum":1,"maximum":100,"description":"Most nodes, 1–100; what the quotas count (nodes per node group, and nodes per cluster summed over its node groups; 20 and 50 by default): 409 QuotaExceeded above them"}},"required":["name","instanceType","minSize","desiredSize","maxSize"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreateNodegroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/nodegroups/{name}":{"get":{"operationId":"eks.nodegroups.get","summary":"One node group and its nodes","description":"`eks:DescribeNodegroup` One node group and its nodes.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DescribeNodegroup","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"eks.nodegroups.update","summary":"Scale a node group or change its labels and taints","description":"`eks:UpdateNodegroupConfig` Scale a node group or change its labels and taints. Scaling down drains the nodes it removes (respecting PodDisruptionBudgets) first.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"minSize":{"description":"Fewest nodes, 0–100; the cluster autoscaler never goes below it. minSize ≤ desiredSize ≤ maxSize, else 400, checked against the sizes not sent. Unchanged when absent","type":"integer","minimum":0,"maximum":100},"desiredSize":{"description":"Nodes to run now, 0–100; with autoscaling on, the cluster autoscaler changes it between minSize and maxSize. Scaling down drains the nodes it removes. Unchanged when absent","type":"integer","minimum":0,"maximum":100},"maxSize":{"description":"Most nodes, 1–100; what the quotas count (nodes per node group, and nodes per cluster summed over its node groups; 20 and 50 by default): 409 QuotaExceeded above them; only growth is checked, shrinking is always allowed. Unchanged when absent","type":"integer","minimum":1,"maximum":100},"labels":{"description":"Replaces the node labels as a whole; at most 20, kubernetes.io/, k8s.io/ and eks.ews.cloud/ keys refused (400). {} removes them all. Unchanged when absent","type":"object","propertyNames":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"additionalProperties":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"}},"taints":{"description":"Replaces the node taints as a whole: { key, value?, effect: NoSchedule | PreferNoSchedule | NoExecute }; at most 10. [] removes them all. Unchanged when absent","maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$"},"value":{"type":"string","pattern":"^(([A-Za-z0-9][-A-Za-z0-9_.]{0,61})?[A-Za-z0-9])?$"},"effect":{"type":"string","enum":["NoSchedule","PreferNoSchedule","NoExecute"]}},"required":["key","effect"]}},"instanceType":{"description":"Instance type for nodes created from now on, e.g. performance-4 (provider names still accepted, deprecated); nodes already running keep theirs until they are replaced. A group stopped after failed nodes starts again","type":"string","minLength":1,"maxLength":32},"drainTimeoutMinutes":{"description":"Upgrades: minutes a node’s drain may wait on PodDisruptionBudgets; default 60","type":"integer","minimum":5,"maximum":1440},"forceAfterTimeout":{"description":"Upgrades: after the timeout, remove the node anyway (true) or pause the upgrade (false, default)","type":"boolean"},"autoscaling":{"description":"Let the cluster autoscaler change desiredSize between minSize and maxSize (pending pods grow the group, underused nodes shrink it)","type":"boolean"},"zones":{"description":"Availability zones the nodes spread over, balanced (e.g. [\"de1a\",\"de1b\"]); default the region’s default zone. Applies to nodes created from then on","maxItems":4,"type":"array","items":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"}},"instanceTypes":{"description":"Instance types to buy, in order, when instanceType is sold out in a zone (same CPU architecture), e.g. performance-8","maxItems":8,"type":"array","items":{"type":"string","pattern":"^[a-z0-9-]{2,24}$"}},"capacityFallback":{"description":"Stock fallback; default off. otherZones: zones outside `zones` may be used; equivalentTypes: an equivalent server type may be bought","type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateNodegroupConfig","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"eks.nodegroups.delete","summary":"Delete a node group and its nodes","description":"`eks:DeleteNodegroup` Delete a node group and its nodes.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeleteNodegroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/nodegroups/{name}/version":{"put":{"operationId":"eks.nodegroups.upgrade","summary":"Upgrade a node group to the cluster’s Kubernetes minor","description":"`eks:UpdateNodegroupVersion` Upgrade a node group to the cluster’s Kubernetes minor. Surge replacement: one extra node at the new minor, then one node behind is drained and removed, until none is behind. PodDisruptionBudgets are respected for the group’s drainTimeoutMinutes (default 60) per node; then the upgrade pauses at that node, or with forceAfterTimeout the node goes anyway. Never above the control plane’s minor.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]([a-z0-9-]{0,30}[a-z0-9])?$","description":"Node group name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"description":"Kubernetes minor for the nodes; default the cluster’s, never above it","type":"string","enum":["1.36","1.37"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateNodegroupVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/pod-identity-associations":{"get":{"operationId":"eks.pod-identity-associations.list","summary":"List a cluster’s pod identity associations","description":"`eks:ListPodIdentityAssociations` List a cluster’s pod identity associations.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListPodIdentityAssociations","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.pod-identity-associations.create","summary":"Let pods of a service account act as an IAM role","description":"`eks:CreatePodIdentityAssociation` Let pods of a service account act as an IAM role. Also needs iam:PassRole on the role. Pods created afterwards get AWS_ROLE_ARN, AWS_WEB_IDENTITY_TOKEN_FILE and AWS_ENDPOINT_URL_STS/S3, so AWS SDKs work unchanged. 409 when the service account already has one.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"namespace":{"type":"string","pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","description":"Namespace of the service account"},"serviceAccount":{"type":"string","maxLength":253,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$","description":"Service account whose pods get the role"},"role":{"type":"string","minLength":1,"maxLength":128,"description":"Name of the IAM role the pods act as; needs iam:PassRole on it"}},"required":["namespace","serviceAccount","role"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreatePodIdentityAssociation","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/pod-identity-associations/{id}":{"delete":{"operationId":"eks.pod-identity-associations.delete","summary":"Remove a pod identity association","description":"`eks:DeletePodIdentityAssociation` Remove a pod identity association. Credentials already issued run out within the hour.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Association id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeletePodIdentityAssociation","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/restore":{"post":{"operationId":"eks.clusters.restore","summary":"Restore the control plane from one of the cluster’s etcd snapshots","description":"`eks:RestoreCluster` Restore the control plane from one of the cluster’s etcd snapshots. Every Kubernetes object returns to the snapshot; objects created since are gone. A pre-restore snapshot is taken first, so a restore can be undone. Then every control-plane machine is replaced: the API is down until the first new one has restored etcd (about 5–10 minutes), worker nodes keep running their pods and reconnect, kubeconfigs keep working (same CA and endpoint). Only verified snapshots; `confirm` must be the cluster’s name. 409 unless the cluster is active (one restore at a time, none during an upgrade or a deletion). A customer’s restore is excluded from the SLA for its first 30 minutes.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"snapshotId":{"type":"string","pattern":"^etcds-[0-9a-f]{12}$","description":"A verified snapshot of this cluster (`dcloud eks snapshots list`)"},"confirm":{"type":"string","minLength":1,"maxLength":100,"description":"The cluster’s name, to confirm: every object created after the snapshot is lost"}},"required":["snapshotId","confirm"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:RestoreCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/snapshots":{"get":{"operationId":"eks.snapshots.list","summary":"List the cluster’s etcd snapshots and its backup status","description":"`eks:ListClusterSnapshots` List the cluster’s etcd snapshots and its backup status. Deutsche Cloud takes one every hour (kept 7 days, the first of each UTC day 30 days), before every upgrade and restore, and on deletion (kept 7 days); on-demand ones are kept 30 days, the 10 newest. Each is checked by restoring it into a scratch directory on the machine (`verifiedAt`), sealed under Deutsche Cloud’s master key in its object storage. The newest verified one is never deleted. `backup.status` is `stale` without a verified snapshot for 2 hours, `not-enabled` for a control plane built before backups (replace it to enable them). Snapshots cannot be downloaded.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListClusterSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"eks.snapshots.create","summary":"Take an etcd snapshot now","description":"`eks:CreateClusterSnapshot` Take an etcd snapshot now. One in flight and at most one per 10 minutes (409 otherwise). `evicts` names the on-demand snapshot this one pushes out of the 10 kept. The snapshot is `pending` until the leading control-plane machine has taken, checked and uploaded it, usually within a minute.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:CreateClusterSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/token":{"post":{"operationId":"eks.clusters.token","summary":"A 10-minute Kubernetes API token for the cluster, as an ExecCredential","description":"`eks:AccessKubernetesApi` A 10-minute Kubernetes API token for the cluster, as an ExecCredential. Needs eks:AccessKubernetesApi AND an access entry on the cluster (403 otherwise). The token carries your Deutsche Cloud identity as `ews:<username>` and your access entries as groups; `aud` is the cluster id.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:AccessKubernetesApi","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/upgrade/cancel":{"post":{"operationId":"eks.clusters.cancel-upgrade","summary":"Cancel a control-plane upgrade before its first machine is replaced","description":"`eks:UpdateClusterVersion` Cancel a control-plane upgrade before its first machine is replaced. The cluster goes back to the minor its control plane runs (`upgrade.canCancel`). 409 once a machine runs the new minor (the upgrade can only go on), and for Deutsche Cloud’s upgrade after the end of support.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateClusterVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/upgrade/retry":{"post":{"operationId":"eks.clusters.retry-upgrade","summary":"Ask again, now, for the pre-upgrade snapshot a held upgrade waits for","description":"`eks:UpdateClusterVersion` Ask again, now, for the pre-upgrade snapshot a held upgrade waits for. An upgrade replaces no machine until its own pre-upgrade etcd snapshot is verified; when that snapshot fails the upgrade is held (`upgrade.held` on the cluster) and Deutsche Cloud retries every 15 minutes. This asks now: at most once per 5 minutes, 409 while one is being taken or when nothing is held.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateClusterVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/clusters/{cluster}/version":{"put":{"operationId":"eks.clusters.upgrade","summary":"Upgrade the control plane to the next Kubernetes minor","description":"`eks:UpdateClusterVersion` Upgrade the control plane to the next Kubernetes minor. One minor at a time, never down. Each control-plane machine is replaced by one at the new minor, one at a time; the API answers throughout (dev tier too). The cluster is updating until every machine runs the new minor; then upgrade node groups with `nodegroups upgrade`. 409 while the cluster is not active or its control plane is not settled.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","pattern":"^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$","description":"Cluster id (ewk-…) or name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","enum":["1.36","1.37"],"description":"The next Kubernetes minor, one above the cluster’s"}},"required":["version"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:UpdateClusterVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/deleted-clusters":{"get":{"operationId":"eks.deleted-clusters.list","summary":"List deleted clusters that can be restored, with their expiry and kept volumes","description":"`eks:ListClusters` List deleted clusters that can be restored, with their expiry and kept volumes.","tags":["Kubernetes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/eks/api/deleted-clusters/{cluster}/purge":{"post":{"operationId":"eks.deleted-clusters.purge","summary":"Delete what a deleted cluster kept, now: final snapshot, key material, volumes","description":"`eks:DeleteCluster` Delete what a deleted cluster kept, now: final snapshot, key material, volumes. Irreversible: the cluster can no longer be restored. Otherwise this happens on its own 7 days after the deletion. `confirm` must be the cluster’s name.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9][a-z0-9-]*$","description":"Deleted cluster id (ewk-…), or its name when only one deleted cluster has it"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"type":"string","minLength":1,"maxLength":100,"description":"The deleted cluster’s name, to confirm: its final snapshot, key material and kept volumes are deleted now, irreversibly"}},"required":["confirm"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:DeleteCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/deleted-clusters/{cluster}/restore":{"post":{"operationId":"eks.deleted-clusters.restore","summary":"Restore a deleted cluster from its final etcd snapshot","description":"`eks:RestoreCluster` Restore a deleted cluster from its final etcd snapshot. The cluster comes back under the same id and name with its settings, node groups, access entries, add-ons and pod identity associations. Deutsche Cloud builds the control plane again from the final snapshot (same CA and keys, the same endpoint name, behind a new load balancer whose address may change; kubeconfigs keep working), then the node groups’ nodes; the kept volumes attach again when their pods run; Service load balancers get new addresses. Billed and counted in the quota from the restore on. 409 when the name is taken by another cluster, the quota is full, the VPC is gone or the 7 days are over. `confirm` must be the cluster’s name.","tags":["Kubernetes"],"parameters":[{"name":"cluster","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9][a-z0-9-]*$","description":"Deleted cluster id (ewk-…), or its name when only one deleted cluster has it"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"type":"string","minLength":1,"maxLength":100,"description":"The deleted cluster’s name, to confirm"}},"required":["confirm"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:RestoreCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/eks/api/versions":{"get":{"operationId":"eks.versions.list","summary":"List Kubernetes versions, control-plane tiers and node server types","description":"`eks:ListClusters` List Kubernetes versions, control-plane tiers and node server types.","tags":["Kubernetes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"eks:ListClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/email/api/account":{"get":{"operationId":"email.account.get","summary":"Sandbox state, quotas, use in the last 24 hours and the 7-day reputation","description":"`email:GetEmailAccount` Sandbox state, quotas, use in the last 24 hours and the 7-day reputation.","tags":["Email"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:GetEmailAccount","x-ews-mutates":false,"x-ews-sensitive":false}},"/email/api/account/production-access":{"post":{"operationId":"email.account.request-production-access","summary":"Ask to send to anyone, not only to verified addresses","description":"`email:RequestProductionAccess` Ask to send to anyone, not only to verified addresses. Describe what you send, to whom, roughly how many a day, and how recipients asked for it. Support reviews it; until then only verified identities can receive.","tags":["Email"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"useCase":{"type":"string","minLength":20,"maxLength":4000}},"required":["useCase"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:RequestProductionAccess","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/identities":{"get":{"operationId":"email.identities.list","summary":"List sender domains with their state and the DNS records they need","description":"`email:ListEmailIdentities` List sender domains with their state and the DNS records they need.","tags":["Email"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:ListEmailIdentities","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"email.identities.create","summary":"Add a sender domain","description":"`email:CreateEmailIdentity` Add a sender domain. Generates a 2048-bit DKIM key. The domain is verified once public DNS returns the DKIM record listed in `records`; with customMailFrom (default) `bounce.<domain>` also needs its MX and SPF records so SPF passes aligned. If the domain is in one of your Deutsche Cloud DNS zones, `dns-records` writes them for you.","tags":["Email"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":253},"customMailFrom":{"default":true,"type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:CreateEmailIdentity","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/identities/{name}":{"get":{"operationId":"email.identities.get","summary":"One sender domain, its verification state and DNS records","description":"`email:GetEmailIdentity` One sender domain, its verification state and DNS records.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:GetEmailIdentity","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"email.identities.update","summary":"Set a sender domain's DMARC policy and report address, and one-click unsubscribe by default","description":"`email:UpdateEmailIdentity` Set a sender domain's DMARC policy and report address, and one-click unsubscribe by default. quarantine and reject need onlySendsThroughEws: true: mail other providers send as the domain without DKIM for it would be lost. The DMARC record changes with the next dns-records call (or publish the value under records yourself). Aggregate reports always go to the platform too and show under dmarc-reports.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dmarcPolicy":{"type":"string","enum":["none","quarantine","reject"]},"onlySendsThroughEws":{"type":"boolean"},"dmarcReportAddress":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"listUnsubscribe":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:UpdateEmailIdentity","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"email.identities.delete","summary":"Remove a sender domain and its DKIM key","description":"`email:DeleteEmailIdentity` Remove a sender domain and its DKIM key.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:DeleteEmailIdentity","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/identities/{name}/dmarc-reports":{"get":{"operationId":"email.identities.dmarc-reports","summary":"What receivers reported about mail sent as this domain (DMARC aggregate reports)","description":"`email:GetEmailIdentity` What receivers reported about mail sent as this domain (DMARC aggregate reports). summary: messages reported, how many passed DMARC, the sources by IP (Deutsche Cloud relays named), and a recommendation for the policy (quarantine after 7 clean days, reject after 30 under quarantine). reports: each report with its rows.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}},{"name":"days","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":1,"maximum":180}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:GetEmailIdentity","x-ews-mutates":false,"x-ews-sensitive":false}},"/email/api/identities/{name}/dns-records":{"post":{"operationId":"email.identities.dns-records","summary":"Write the domain's DKIM, MAIL FROM and DMARC records into its Deutsche Cloud DNS zone","description":"`email:PutEmailIdentityDnsRecords` Write the domain's DKIM, MAIL FROM and DMARC records into its Deutsche Cloud DNS zone. Needs dns:ChangeRecords on the zone too. A record set already at a name is kept (an existing DMARC policy is never replaced); the result says what was created, unchanged or skipped.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:PutEmailIdentityDnsRecords","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/identities/{name}/verify":{"post":{"operationId":"email.identities.verify","summary":"Check the DNS records now and report what each lookup found","description":"`email:VerifyEmailIdentity` Check the DNS records now and report what each lookup found.","tags":["Email"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"pattern":"^[a-z0-9.-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:VerifyEmailIdentity","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/messages":{"get":{"operationId":"email.messages.list","summary":"Recent messages, newest first, with each recipient’s delivery state","description":"`email:ListEmailMessages` Recent messages, newest first, with each recipient’s delivery state.","tags":["Email"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["queued","delivered","deferred","bounced","complained","suppressed","rejected"]}},{"name":"recipient","in":"query","required":false,"schema":{"type":"string","maxLength":320}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:ListEmailMessages","x-ews-mutates":false,"x-ews-sensitive":false}},"/email/api/messages/{id}":{"get":{"operationId":"email.messages.get","summary":"One message with every delivery event of every recipient","description":"`email:GetEmailMessage` One message with every delivery event of every recipient.","tags":["Email"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:GetEmailMessage","x-ews-mutates":false,"x-ews-sensitive":false}},"/email/api/send":{"post":{"operationId":"email.messages.send","summary":"Send a message built from fields","description":"`email:SendEmail` Send a message built from fields. The From domain must be a verified sender domain; IAM checks email:SendEmail on it. text, html or both; attachments are base64 (10 MB per message in all). Answers 202 with the message id and each recipient as queued, or suppressed when the address is on the suppression list (accepted, never sent). In the sandbox every recipient must be a verified identity of the organization. unsubscribe: true adds RFC 8058 one-click unsubscribe headers to each recipient’s copy (a click puts the address on the suppression list); added anyway when the domain’s listUnsubscribe is on or the organization sent 4,000 or more in 24 hours.","tags":["Email"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","minLength":3,"maxLength":998},"to":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":3,"maxLength":320}},"cc":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":3,"maxLength":320}},"bcc":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":3,"maxLength":320}},"replyTo":{"type":"string","maxLength":998},"subject":{"type":"string","maxLength":998},"text":{"type":"string"},"html":{"type":"string"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255},"contentType":{"type":"string","maxLength":255},"content":{"type":"string"}},"required":["filename","content"]}},"unsubscribe":{"type":"boolean"}},"required":["from","subject"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:SendEmail","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/send-raw":{"post":{"operationId":"email.messages.send-raw","summary":"Send a complete RFC 5322 message (base64)","description":"`email:SendEmail` Send a complete RFC 5322 message (base64). Recipients are taken from `recipients`, not from the headers, so Bcc stays private. A Message-ID and Date are added when missing. unsubscribe (or the header X-DCLOUD-Unsubscribe: one-click, or X-EWS-Unsubscribe, removed before sending) as for send.","tags":["Email"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"raw":{"type":"string","minLength":1},"recipients":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":3,"maxLength":320}},"unsubscribe":{"type":"boolean"}},"required":["raw","recipients"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:SendEmail","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/suppressions":{"get":{"operationId":"email.suppressions.list","summary":"List suppressed addresses, newest first","description":"`email:ListSuppressedDestinations` List suppressed addresses, newest first.","tags":["Email"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":200,"type":"integer","minimum":1,"maximum":1000}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":320}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:ListSuppressedDestinations","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"email.suppressions.put","summary":"Add an address to the suppression list","description":"`email:PutSuppressedDestination` Add an address to the suppression list.","tags":["Email"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["address"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:PutSuppressedDestination","x-ews-mutates":true,"x-ews-sensitive":false}},"/email/api/suppressions/{address}":{"delete":{"operationId":"email.suppressions.delete","summary":"Remove an address from the suppression list, so mail is sent to it again","description":"`email:DeleteSuppressedDestination` Remove an address from the suppression list, so mail is sent to it again.","tags":["Email"],"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"email:DeleteSuppressedDestination","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/auth-tokens":{"post":{"operationId":"errors.auth-tokens.create","summary":"Create a SENTRY_AUTH_TOKEN (an access key of yours capped to errors:*), shown once","description":"`errors:UploadSourceMaps` Create a SENTRY_AUTH_TOKEN (an access key of yours capped to errors:*), shown once. sentry-cli reads the URL and organization from the token: SENTRY_AUTH_TOKEN alone redirects it here.","tags":["Error Tracking"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"default":"sentry-cli","type":"string","minLength":1,"maxLength":200},"expiresInDays":{"type":"integer","minimum":1,"maximum":3650}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UploadSourceMaps","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:CreateAccessKey"]}},"/errors/api/issues/{issueId}":{"get":{"operationId":"errors.issues.get","summary":"Read an issue with its 14-day hourly counts and tag distribution","description":"`errors:ListIssues` Read an issue with its 14-day hourly counts and tag distribution.","tags":["Error Tracking"],"parameters":[{"name":"issueId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(\\d+|[A-Za-z0-9][A-Za-z0-9-]*-[0-9A-Za-z]+)$","description":"Issue number or short id, e.g. 74 or PROOF-NEXTJS-22 (as the console shows it)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListIssues","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/issues/{issueId}/events":{"get":{"operationId":"errors.events.list","summary":"List an issue’s events, newest first","description":"`errors:GetEvents` List an issue’s events, newest first.","tags":["Error Tracking"],"parameters":[{"name":"issueId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(\\d+|[A-Za-z0-9][A-Za-z0-9-]*-[0-9A-Za-z]+)$","description":"Issue number or short id, e.g. 74 or PROOF-NEXTJS-22 (as the console shows it)"}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/issues/{issueId}/events/latest":{"get":{"operationId":"errors.events.latest","summary":"Read an issue’s latest event in full","description":"`errors:GetEvents` Read an issue’s latest event in full.","tags":["Error Tracking"],"parameters":[{"name":"issueId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^(\\d+|[A-Za-z0-9][A-Za-z0-9-]*-[0-9A-Za-z]+)$","description":"Issue number or short id, e.g. 74 or PROOF-NEXTJS-22 (as the console shows it)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/profiles/{eventId}":{"get":{"operationId":"errors.profiles.get","summary":"Read a transaction’s profile: its call tree (flame graph) and its functions by self time","description":"`errors:GetEvents` Read a transaction’s profile: its call tree (flame graph) and its functions by self time.","tags":["Error Tracking"],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-fA-F]{32}$|^[0-9a-fA-F-]{36}$","description":"The transaction’s event id, as the trace view lists it"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects":{"get":{"operationId":"errors.projects.list","summary":"List projects with their DSNs, unresolved issues and events of the last 24 hours","description":"`errors:ListProjects` List projects with their DSNs, unresolved issues and events of the last 24 hours.","tags":["Error Tracking"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"errors.projects.create","summary":"Create a project and its first DSN key","description":"`errors:CreateProject` Create a project and its first DSN key. The answer carries the DSN to put into the Sentry SDK (`Sentry.init({ dsn })`).","tags":["Error Tracking"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"platform":{"default":"other","type":"string","enum":["javascript-nextjs","javascript","node","python","go","other"]},"slug":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,49}$"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:CreateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}":{"get":{"operationId":"errors.projects.get","summary":"Read a project, its keys and DSNs","description":"`errors:ListProjects` Read a project, its keys and DSNs.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"errors.projects.update","summary":"Change a project: name, platform, retention, rate limit, client IP, alerts","description":"`errors:UpdateProject` Change a project: name, platform, retention, rate limit, client IP, alerts.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"platform":{"type":"string","enum":["javascript-nextjs","javascript","node","python","go","other"]},"retentionDays":{"anyOf":[{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":90}]},"rateLimitPerMinute":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"storeClientIp":{"type":"boolean"},"alertEmail":{"type":"boolean"},"alertEmailAddresses":{"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"alertWebhookUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"errors.projects.delete","summary":"Delete a project: its keys stop working at once, its issues and events go","description":"`errors:DeleteProject` Delete a project: its keys stop working at once, its issues and events go.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:DeleteProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/alert-rules":{"get":{"operationId":"errors.alert-rules.list","summary":"List a project’s alert rules and their latest firings","description":"`errors:ListAlertRules` List a project’s alert rules and their latest firings.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListAlertRules","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"errors.alert-rules.create","summary":"Create an alert rule","description":"`errors:PutAlertRule` Create an alert rule.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"enabled":{"default":true,"type":"boolean"},"trigger":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"issue"},"events":{"minItems":1,"type":"array","items":{"type":"string","enum":["new","regression","escalating"]}}},"required":["kind","events"]},{"type":"object","properties":{"kind":{"type":"string","const":"frequency"},"events":{"type":"integer","minimum":1,"maximum":10000000},"windowMinutes":{"type":"integer","minimum":1,"maximum":1440}},"required":["kind","events","windowMinutes"]},{"type":"object","properties":{"kind":{"type":"string","const":"users"},"users":{"type":"integer","minimum":1,"maximum":10000000},"windowMinutes":{"type":"integer","minimum":1,"maximum":1440}},"required":["kind","users","windowMinutes"]},{"type":"object","properties":{"kind":{"type":"string","const":"crash_free"},"belowPercent":{"type":"number","minimum":1,"maximum":99.99},"minSessions":{"default":100,"type":"integer","minimum":1,"maximum":10000000}},"required":["kind","belowPercent"]}]},"filters":{"default":{"levels":[],"environments":[],"tags":[]},"type":"object","properties":{"levels":{"default":[],"maxItems":5,"type":"array","items":{"type":"string","enum":["fatal","error","warning","info","debug"]}},"environments":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":64}},"tags":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":200}},"required":["key","value"]}},"titleContains":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"actions":{"minItems":1,"maxItems":10,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"email"},"admins":{"default":true,"type":"boolean"},"addresses":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"webhook"},"url":{"type":"string","maxLength":2000,"format":"uri"},"format":{"default":"auto","type":"string","enum":["auto","slack","teams","discord","json"]}},"required":["kind","url"]}]}},"throttleMinutes":{"default":30,"type":"integer","minimum":1,"maximum":10080}},"required":["name","trigger","actions"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:PutAlertRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/alert-rules/{ruleId}":{"patch":{"operationId":"errors.alert-rules.update","summary":"Change an alert rule, or turn it on or off","description":"`errors:PutAlertRule` Change an alert rule, or turn it on or off.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alert rule id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"enabled":{"default":true,"type":"boolean"},"trigger":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"issue"},"events":{"minItems":1,"type":"array","items":{"type":"string","enum":["new","regression","escalating"]}}},"required":["kind","events"]},{"type":"object","properties":{"kind":{"type":"string","const":"frequency"},"events":{"type":"integer","minimum":1,"maximum":10000000},"windowMinutes":{"type":"integer","minimum":1,"maximum":1440}},"required":["kind","events","windowMinutes"]},{"type":"object","properties":{"kind":{"type":"string","const":"users"},"users":{"type":"integer","minimum":1,"maximum":10000000},"windowMinutes":{"type":"integer","minimum":1,"maximum":1440}},"required":["kind","users","windowMinutes"]},{"type":"object","properties":{"kind":{"type":"string","const":"crash_free"},"belowPercent":{"type":"number","minimum":1,"maximum":99.99},"minSessions":{"default":100,"type":"integer","minimum":1,"maximum":10000000}},"required":["kind","belowPercent"]}]},"filters":{"default":{"levels":[],"environments":[],"tags":[]},"type":"object","properties":{"levels":{"default":[],"maxItems":5,"type":"array","items":{"type":"string","enum":["fatal","error","warning","info","debug"]}},"environments":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":64}},"tags":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":200}},"required":["key","value"]}},"titleContains":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"actions":{"minItems":1,"maxItems":10,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"email"},"admins":{"default":true,"type":"boolean"},"addresses":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"webhook"},"url":{"type":"string","maxLength":2000,"format":"uri"},"format":{"default":"auto","type":"string","enum":["auto","slack","teams","discord","json"]}},"required":["kind","url"]}]}},"throttleMinutes":{"default":30,"type":"integer","minimum":1,"maximum":10080}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:PutAlertRule","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"errors.alert-rules.delete","summary":"Delete an alert rule and its history","description":"`errors:DeleteAlertRule` Delete an alert rule and its history.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alert rule id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:DeleteAlertRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/alert-rules/{ruleId}/test":{"post":{"operationId":"errors.alert-rules.test","summary":"Send the rule’s alert now with sample data, to check its mail and webhooks","description":"`errors:PutAlertRule` Send the rule’s alert now with sample data, to check its mail and webhooks.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alert rule id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:PutAlertRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/ci-bindings":{"post":{"operationId":"errors.connections.connect-ci","summary":"Connect a repository’s CI environment: its jobs exchange their OIDC token for an upload token","description":"`ci:PutEnvironment` Connect a repository’s CI environment: its jobs exchange their OIDC token for an upload token. A job with `environment: <name>` and `permissions: id-token: write` requests an OIDC token with the audience errors.<root> and posts it to /errors/api/upload-token/exchange. Pull-request runs are refused; the token is revoked when the run ends.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"repositoryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Git repository id"},"environment":{"type":"string","minLength":1,"maxLength":255,"description":"CI environment name, as a job’s `environment:` names it; created when missing"},"sentryEnvironment":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[^\\s/]+$","description":"SENTRY_ENVIRONMENT; omitted: the app’s secrets environment, else production"},{"type":"null"}]}},"required":["repositoryId","environment"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutEnvironment","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["errors:UpdateProject"]}},"/errors/api/projects/{id}/ci-bindings/{bindingId}":{"delete":{"operationId":"errors.connections.disconnect-ci","summary":"Disconnect a CI environment","description":"`ci:PutEnvironment` Disconnect a CI environment.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"bindingId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"CI binding id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:PutEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/connections":{"get":{"operationId":"errors.connections.get","summary":"What is connected: apps, CI environments, the managed key and secret, the last upload tokens (no secrets)","description":"`errors:ListProjects` What is connected: apps, CI environments, the managed key and secret, the last upload tokens (no secrets).","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/events/{eventId}":{"get":{"operationId":"errors.events.get","summary":"Read one event in full","description":"`errors:GetEvents` Read one event in full.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"eventId","in":"path","required":true,"schema":{"description":"Event id (32 hex characters)","type":"string","pattern":"^[0-9a-fA-F]{32}$|^[0-9a-fA-F-]{36}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/issues":{"get":{"operationId":"errors.issues.list","summary":"List a project’s issues","description":"`errors:ListIssues` List a project’s issues. query takes Sentry’s search syntax: is:unresolved|resolved|ignored|all (default unresolved), level:, environment:, release:, assigned:me|none, any tag as key:value, and free text over title, culprit and location.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}},{"name":"sort","in":"query","required":false,"schema":{"default":"last_seen","type":"string","enum":["last_seen","first_seen","events","users"]}},{"name":"environment","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["1h","24h","7d","14d","30d","90d"]}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"type":"integer","minimum":0,"maximum":100000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListIssues","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"errors.issues.update","summary":"Resolve, reopen, ignore or assign issues","description":"`errors:UpdateIssue` Resolve, reopen, ignore or assign issues.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"action":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"resolve"},"inNextRelease":{"default":false,"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"unresolve"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"ignore"},"forMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":525600},{"type":"null"}]},"untilCount":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000000000},{"type":"null"}]}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"assign"},"iamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["type","iamUserId"]}]}},"required":["ids","action"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateIssue","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"errors.issues.delete","summary":"Delete issues and their events","description":"`errors:DeleteIssue` Delete issues and their events.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}},"required":["ids"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:DeleteIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/keys":{"post":{"operationId":"errors.keys.create","summary":"Add a DSN key","description":"`errors:UpdateProject` Add a DSN key.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"default":"Key","type":"string","minLength":1,"maxLength":64},"rateLimitPerMinute":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/keys/{keyId}":{"delete":{"operationId":"errors.keys.revoke","summary":"Revoke a DSN key; the ingest refuses it within seconds","description":"`errors:UpdateProject` Revoke a DSN key; the ingest refuses it within seconds.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Key id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/profiles":{"get":{"operationId":"errors.profiles.list","summary":"List a project’s continuous profile chunks in a window (last 15 min, hour, day or custom): filters, samples per minute, the chunks","description":"`errors:GetEvents` List a project’s continuous profile chunks in a window (last 15 min, hour, day or custom): filters, samples per minute, the chunks.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"window","in":"query","required":false,"schema":{"default":"1h","description":"Last 15 minutes, hour or day, or custom with from/to","type":"string","enum":["15m","1h","24h","custom"]}},{"name":"from","in":"query","required":false,"schema":{"description":"Custom window start (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"schema":{"description":"Custom window end (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"environment","in":"query","required":false,"schema":{"description":"Only chunks of this environment","type":"string","maxLength":200}},{"name":"release","in":"query","required":false,"schema":{"description":"Only chunks of this release","type":"string","maxLength":200}},{"name":"runtime","in":"query","required":false,"schema":{"description":"node, browser or python","type":"string","enum":["node","browser","python"]}},{"name":"profiler","in":"query","required":false,"schema":{"description":"Only this profiler (one per process or page)","type":"string","pattern":"^[0-9a-fA-F-]{32,36}$"}},{"name":"thread","in":"query","required":false,"schema":{"description":"Thread id (default: the busiest)","type":"string","maxLength":100}},{"name":"myCode","in":"query","required":false,"schema":{"description":"Only in-app frames (\"only my code\")","type":"string","enum":["0","1","true","false"]}},{"name":"compare","in":"query","required":false,"schema":{"description":"Also the previous window of the same length, per function","type":"string","enum":["0","1","true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/profiles/flamegraph":{"get":{"operationId":"errors.profiles.flamegraph","summary":"Merge a project’s continuous profiles in a window into one flame graph, with its slowest functions by self time (optionally only in-app frames, or compared with the previous window)","description":"`errors:GetEvents` Merge a project’s continuous profiles in a window into one flame graph, with its slowest functions by self time (optionally only in-app frames, or compared with the previous window).","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"window","in":"query","required":false,"schema":{"default":"1h","description":"Last 15 minutes, hour or day, or custom with from/to","type":"string","enum":["15m","1h","24h","custom"]}},{"name":"from","in":"query","required":false,"schema":{"description":"Custom window start (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"schema":{"description":"Custom window end (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"environment","in":"query","required":false,"schema":{"description":"Only chunks of this environment","type":"string","maxLength":200}},{"name":"release","in":"query","required":false,"schema":{"description":"Only chunks of this release","type":"string","maxLength":200}},{"name":"runtime","in":"query","required":false,"schema":{"description":"node, browser or python","type":"string","enum":["node","browser","python"]}},{"name":"profiler","in":"query","required":false,"schema":{"description":"Only this profiler (one per process or page)","type":"string","pattern":"^[0-9a-fA-F-]{32,36}$"}},{"name":"thread","in":"query","required":false,"schema":{"description":"Thread id (default: the busiest)","type":"string","maxLength":100}},{"name":"myCode","in":"query","required":false,"schema":{"description":"Only in-app frames (\"only my code\")","type":"string","enum":["0","1","true","false"]}},{"name":"compare","in":"query","required":false,"schema":{"description":"Also the previous window of the same length, per function","type":"string","enum":["0","1","true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/queries":{"get":{"operationId":"errors.queries.list","summary":"List a project’s database statements by total time: calls, mean and slowest call, time share, N+1 transactions","description":"`errors:GetEvents` List a project’s database statements by total time: calls, mean and slowest call, time share, N+1 transactions.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","type":"string","enum":["24h","7d"]}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/release-health":{"get":{"operationId":"errors.release-health.list","summary":"List a project’s releases with their sessions, crash-free sessions and users, adoption and new issues","description":"`errors:GetEvents` List a project’s releases with their sessions, crash-free sessions and users, adoption and new issues.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"range","in":"query","required":false,"schema":{"default":"14d","type":"string","enum":["24h","14d"]}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/rotate-key":{"post":{"operationId":"errors.connections.rotate-key","summary":"Rotate the managed DSN key: new key, every connected app rebuilt, the old key revoked after the grace","description":"`errors:UpdateProject` Rotate the managed DSN key: new key, every connected app rebuilt, the old key revoked after the grace. The previous key is revoked once the grace is over AND every connected app runs a build made after the rotation; a failed rebuild holds it. Image and compose apps are listed under rebuildYourself: their browser bundles keep the old DSN until rebuilt.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"graceSeconds":{"default":86400,"description":"Seconds the previous key keeps working; it is revoked after that once every connected app runs a build made after the rotation","type":"integer","minimum":600,"maximum":604800}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/rotate-key/extend":{"post":{"operationId":"errors.connections.extend-grace","summary":"Move the rotated-out key’s revocation","description":"`errors:UpdateProject` Move the rotated-out key’s revocation.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"graceSeconds":{"type":"integer","minimum":600,"maximum":604800}},"required":["graceSeconds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/rotate-key/revoke-previous":{"post":{"operationId":"errors.connections.revoke-previous-key","summary":"Revoke the rotated-out key now (its events are refused from then on)","description":"`errors:UpdateProject` Revoke the rotated-out key now (its events are refused from then on).","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/transactions":{"get":{"operationId":"errors.transactions.list","summary":"List a project’s transactions by name: count (sampled and extrapolated), p50/p75/p95 duration and failure rate","description":"`errors:GetEvents` List a project’s transactions by name: count (sampled and extrapolated), p50/p75/p95 duration and failure rate.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","type":"string","enum":["24h","7d"]}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/projects/{id}/upload-token":{"post":{"operationId":"errors.auth-tokens.create-upload-token","summary":"A short-lived SENTRY_AUTH_TOKEN for one project: source-map upload only, at most an hour","description":"`errors:UploadSourceMaps` A short-lived SENTRY_AUTH_TOKEN for one project: source-map upload only, at most an hour. For builds elsewhere: a GitHub workflow exchanges its OIDC token at the STS for a temporary access key, then asks for this token, so no static secret lives in GitHub (docs/errors.md, \"Builds on GitHub Actions\"). Never outlives the calling key; revoked at expiry.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ttlSeconds":{"default":3600,"description":"Lifetime, at most an hour (and never beyond the caller’s own credential)","type":"integer","minimum":60,"maximum":3600}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:UploadSourceMaps","x-ews-mutates":true,"x-ews-sensitive":false}},"/errors/api/projects/{id}/usage":{"get":{"operationId":"errors.projects.usage","summary":"What the ingest received for the project in the last 30 days, by category and outcome","description":"`errors:ListProjects` What the ingest received for the project in the last 30 days, by category and outcome.","tags":["Error Tracking"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Project id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/queries":{"get":{"operationId":"errors.queries.get","summary":"Read one statement across the organization’s projects: per project, slowest calls, N+1 transactions and where it ran","description":"`errors:GetEvents` Read one statement across the organization’s projects: per project, slowest calls, N+1 transactions and where it ran.","tags":["Error Tracking"],"parameters":[{"name":"fp","in":"query","required":true,"schema":{"type":"string","pattern":"^sqlfp1:[0-9a-f]{16}$","description":"The statement fingerprint, sqlfp1:<16 hex>, as the Queries tab and the database’s query insights show it"}},{"name":"project","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","type":"string","enum":["24h","7d"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/releases":{"get":{"operationId":"errors.releases.list","summary":"List releases","description":"`errors:ListReleases` List releases.","tags":["Error Tracking"],"parameters":[{"name":"projectId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:ListReleases","x-ews-mutates":false,"x-ews-sensitive":false}},"/errors/api/traces/{traceId}":{"get":{"operationId":"errors.traces.get","summary":"Read a trace: its transactions and spans on one time axis, and the errors in it","description":"`errors:GetEvents` Read a trace: its transactions and spans on one time axis, and the errors in it.","tags":["Error Tracking"],"parameters":[{"name":"traceId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Trace id (32 hex characters), as an event’s Trace field shows it"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"errors:GetEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/events/api/archives":{"get":{"operationId":"events.archives.list","summary":"List archives with the events and bytes they hold","description":"`events:ListArchives` List archives with the events and bytes they hold.","tags":["Event bus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListArchives","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"events.archives.create","summary":"Create an archive on a bus","description":"`events:CreateArchive` Create an archive on a bus. Keeps every event arriving on eventBus that matches eventPattern (none: all), whether a rule matched it or not, for retentionDays (default 90). Billed per GB-month held (storage.events.gb_month, €0.10). An archive on the default bus keeps the organization’s API activity and also needs iam:GetAuditLogs. At most 10 per bus, 50 per organization; 409 when the name is taken.","tags":["Event bus"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"eventBus":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"The bus whose events it keeps"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"eventPattern":{"description":"Keep only the events matching this pattern (default: every event of the bus)","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"EventBridge event pattern, e.g. {\"source\":[\"ews.ec2\"],\"detail\":{\"eventName\":[\"RunInstances\"]}}. Matchers: exact values, prefix, suffix, equals-ignore-case, anything-but, exists, numeric, wildcard (\"*\"); \"$or\": [{…}, {…}] at any level"},{"type":"null"}]},"retentionDays":{"type":"integer","minimum":1,"maximum":3650,"description":"Days an archived event is kept (1–3650, default 90); lowering it removes older events at the next daily pass"}},"required":["name","eventBus"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:CreateArchive","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["events:DescribeEventBus","iam:GetAuditLogs"]}},"/events/api/archives/{archive}":{"get":{"operationId":"events.archives.get","summary":"Read an archive","description":"`events:DescribeArchive` Read an archive.","tags":["Event bus"],"parameters":[{"name":"archive","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Archive name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeArchive","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"events.archives.update","summary":"Change an archive’s pattern, description or retention","description":"`events:UpdateArchive` Change an archive’s pattern, description or retention. A shorter retention removes the older events at the next daily pass.","tags":["Event bus"],"parameters":[{"name":"archive","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Archive name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"eventPattern":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"EventBridge event pattern, e.g. {\"source\":[\"ews.ec2\"],\"detail\":{\"eventName\":[\"RunInstances\"]}}. Matchers: exact values, prefix, suffix, equals-ignore-case, anything-but, exists, numeric, wildcard (\"*\"); \"$or\": [{…}, {…}] at any level"},{"type":"null"}]},"retentionDays":{"type":"integer","minimum":1,"maximum":3650,"description":"Days an archived event is kept (1–3650, default 90); lowering it removes older events at the next daily pass"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:UpdateArchive","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:GetAuditLogs"]},"delete":{"operationId":"events.archives.delete","summary":"Delete an archive and every event it holds","description":"`events:DeleteArchive` Delete an archive and every event it holds.","tags":["Event bus"],"parameters":[{"name":"archive","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Archive name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DeleteArchive","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/archives/{archive}/events":{"get":{"operationId":"events.archives.events","summary":"The newest events an archive holds","description":"`events:DescribeArchive` The newest events an archive holds.","tags":["Event bus"],"parameters":[{"name":"archive","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Archive name"}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeArchive","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:GetAuditLogs"]}},"/events/api/buses":{"get":{"operationId":"events.buses.list","summary":"List event buses with their rule counts (the default bus always exists)","description":"`events:ListEventBuses` List event buses with their rule counts (the default bus always exists).","tags":["Event bus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListEventBuses","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"events.buses.create","summary":"Create a custom event bus","description":"`events:CreateEventBus` Create a custom event bus.","tags":["Event bus"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:CreateEventBus","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/buses/{bus}":{"get":{"operationId":"events.buses.get","summary":"Read an event bus","description":"`events:DescribeEventBus` Read an event bus.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeEventBus","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"events.buses.delete","summary":"Delete a custom event bus with its rules and their deliveries","description":"`events:DeleteEventBus` Delete a custom event bus with its rules and their deliveries.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DeleteEventBus","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/buses/{bus}/events":{"post":{"operationId":"events.buses.put-events","summary":"Send up to 10 events to a bus; each is matched against its rules","description":"`events:PutEvents` Send up to 10 events to a bus; each is matched against its rules. entries: [{source, detailType, detail, resources?, time?}]. Sources starting with ews. are the platform’s. Answers per entry: {eventId, matchedRules} or {errorCode, errorMessage}; failedEntryCount counts the latter.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":256,"description":"Who sent it, e.g. com.example.orders"},"detailType":{"type":"string","minLength":1,"maxLength":256,"description":"What happened, e.g. Order Placed"},"detail":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"The event’s data: a JSON object"},"resources":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":1600}},"time":{"description":"When it happened (default: now)"}},"required":["source","detailType"]}}},"required":["entries"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:PutEvents","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"events.buses.events","summary":"Recent events kept on a bus (7 days): every PutEvents event, and platform events that matched a rule","description":"`events:DescribeEventBus` Recent events kept on a bus (7 days): every PutEvents event, and platform events that matched a rule.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeEventBus","x-ews-mutates":false,"x-ews-sensitive":false}},"/events/api/buses/{bus}/rules":{"get":{"operationId":"events.rules.list","summary":"List the rules of a bus with their targets and 24 h delivery counts","description":"`events:ListRules` List the rules of a bus with their targets and 24 h delivery counts.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListRules","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"events.rules.create","summary":"Create a rule","description":"`events:PutRule` Create a rule. eventPattern is an EventBridge pattern over the envelope {version, id, detail-type, source, account, time, region, resources, detail}: values are lists of matchers — exact values, {prefix}, {suffix}, {equals-ignore-case}, {anything-but}, {exists}, {numeric:[\">\",0,\"<=\",5]}, {wildcard:\"img/*.png\"} — objects nest, and \"$or\": [{…}, {…}] at any level matches when one branch does. Platform events: source ews.<service> with detail-type \"EWS API Call\" (every successful write; detail.eventName, detail.resource, detail.userIdentity), \"Alarm State Change\" (ews.monitoring), \"Scheduled Invocation Failed\" (ews.scheduler), \"Deployment State Change\" (ews.deploy). targets: up to 5 of {id, type:\"queue\", queueName, messageGroupId?}, {id, type:\"function\", functionName, path?}, {id, type:\"http\", url, method?, headers?, timeoutSeconds?} (signed: X-EWS-Signature-256 = sha256 HMAC of \"<X-EWS-Timestamp>.<body>\" with the rule’s secret), each with roleName (required for queue and function; needs iam:PassRole), one of inputPath ($.detail, $.resources[0]), input (constant) or inputTransformer ({inputPathsMap?: {name: \"$.detail.x\"}, inputTemplate: \"text or JSON with <$.detail.x>, <name>, <ews.events.rule-name>, <ews.events.event.json>\"}), retryMaxAttempts (0–185, default 185), maxEventAgeSeconds (60–86400), deadLetterQueue. Delivery is at least once; X-EWS-Event-Id / the ews-event-id message attribute is the idempotency key. A rule on the default bus sees the organization’s API activity and also needs iam:GetAuditLogs. 409 when the name is taken.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"eventPattern":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"EventBridge event pattern, e.g. {\"source\":[\"ews.ec2\"],\"detail\":{\"eventName\":[\"RunInstances\"]}}. Matchers: exact values, prefix, suffix, equals-ignore-case, anything-but, exists, numeric, wildcard (\"*\"); \"$or\": [{…}, {…}] at any level"},"state":{"type":"string","enum":["enabled","disabled"]},"targets":{"description":"Where matching events go (replaces all on update)","maxItems":5,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"queue"},"queueName":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"messageGroupId":{"description":"FIFO queues: the message group (default: the rule name)","type":"string","minLength":1,"maxLength":128},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","queueName","id"]},{"type":"object","properties":{"type":{"type":"string","const":"function"},"functionName":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"path":{"description":"Request path the event is POSTed to (default /)","type":"string","maxLength":1024,"pattern":"^\\/"},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","functionName","id"]},{"type":"object","properties":{"type":{"type":"string","const":"http"},"url":{"type":"string","maxLength":2048,"description":"https URL on a public address; redirects are not followed"},"method":{"type":"string","enum":["POST","PUT","PATCH"]},"headers":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9-]+$"},"additionalProperties":{"type":"string","maxLength":1000}},"timeoutSeconds":{"type":"integer","minimum":1,"maximum":30},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","url","id"]},{"type":"object","properties":{"type":{"type":"string","const":"rabbitmq"},"broker":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The RabbitMQ broker’s identifier (same org and region)"},"exchange":{"type":"string","maxLength":255,"pattern":"^[A-Za-z0-9_.:-]*$","description":"Exchange on vhost \"/\" to publish to; \"\" is the default exchange (routing key = queue)"},"routingKey":{"description":"Routing key (default: the event’s source, e.g. ews.ec2)","type":"string","maxLength":255},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","broker","exchange","id"]},{"type":"object","properties":{"type":{"type":"string","const":"kafka"},"cluster":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The Kafka cluster’s identifier (same org and region)"},"topic":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$","description":"Topic to produce to (it must exist)"},"key":{"description":"Message key: the event id (default; spreads evenly), its source or detail-type (keeps those in order in one partition), or none","type":"string","enum":["id","source","detail-type","none"]},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","cluster","topic","id"]}]}}},"required":["name","eventPattern"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:PutRule","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["events:PutTargets","iam:PassRole","iam:GetAuditLogs"]}},"/events/api/buses/{bus}/rules/{rule}":{"get":{"operationId":"events.rules.get","summary":"Read a rule, its targets and 24 h delivery counts","description":"`events:DescribeRule` Read a rule, its targets and 24 h delivery counts.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeRule","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"events.rules.update","summary":"Change a rule’s pattern, description, state or targets (targets replace all)","description":"`events:PutRule` Change a rule’s pattern, description, state or targets (targets replace all). state alone needs only events:EnableRule / events:DisableRule. targets: up to 5 of {id, type:\"queue\", queueName, messageGroupId?}, {id, type:\"function\", functionName, path?}, {id, type:\"http\", url, method?, headers?, timeoutSeconds?} (signed: X-EWS-Signature-256 = sha256 HMAC of \"<X-EWS-Timestamp>.<body>\" with the rule’s secret), each with roleName (required for queue and function; needs iam:PassRole), one of inputPath ($.detail, $.resources[0]), input (constant) or inputTransformer ({inputPathsMap?: {name: \"$.detail.x\"}, inputTemplate: \"text or JSON with <$.detail.x>, <name>, <ews.events.rule-name>, <ews.events.event.json>\"}), retryMaxAttempts (0–185, default 185), maxEventAgeSeconds (60–86400), deadLetterQueue. Delivery is at least once; X-EWS-Event-Id / the ews-event-id message attribute is the idempotency key. A rule on the default bus sees the organization’s API activity and also needs iam:GetAuditLogs.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"eventPattern":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"EventBridge event pattern, e.g. {\"source\":[\"ews.ec2\"],\"detail\":{\"eventName\":[\"RunInstances\"]}}. Matchers: exact values, prefix, suffix, equals-ignore-case, anything-but, exists, numeric, wildcard (\"*\"); \"$or\": [{…}, {…}] at any level"},"state":{"type":"string","enum":["enabled","disabled"]},"targets":{"description":"The full list of targets; omitted keeps them","maxItems":5,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"queue"},"queueName":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"messageGroupId":{"description":"FIFO queues: the message group (default: the rule name)","type":"string","minLength":1,"maxLength":128},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","queueName","id"]},{"type":"object","properties":{"type":{"type":"string","const":"function"},"functionName":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"path":{"description":"Request path the event is POSTed to (default /)","type":"string","maxLength":1024,"pattern":"^\\/"},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","functionName","id"]},{"type":"object","properties":{"type":{"type":"string","const":"http"},"url":{"type":"string","maxLength":2048,"description":"https URL on a public address; redirects are not followed"},"method":{"type":"string","enum":["POST","PUT","PATCH"]},"headers":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9-]+$"},"additionalProperties":{"type":"string","maxLength":1000}},"timeoutSeconds":{"type":"integer","minimum":1,"maximum":30},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","url","id"]},{"type":"object","properties":{"type":{"type":"string","const":"rabbitmq"},"broker":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The RabbitMQ broker’s identifier (same org and region)"},"exchange":{"type":"string","maxLength":255,"pattern":"^[A-Za-z0-9_.:-]*$","description":"Exchange on vhost \"/\" to publish to; \"\" is the default exchange (routing key = queue)"},"routingKey":{"description":"Routing key (default: the event’s source, e.g. ews.ec2)","type":"string","maxLength":255},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","broker","exchange","id"]},{"type":"object","properties":{"type":{"type":"string","const":"kafka"},"cluster":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"The Kafka cluster’s identifier (same org and region)"},"topic":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$","description":"Topic to produce to (it must exist)"},"key":{"description":"Message key: the event id (default; spreads evenly), its source or detail-type (keeps those in order in one partition), or none","type":"string","enum":["id","source","detail-type","none"]},"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_.-]+$","description":"The target’s id within the rule"},"roleName":{"description":"IAM role the target acts as; needs iam:PassRole on it. Required for queue and function targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"inputPath":{"description":"Send only this part of the event, e.g. $.detail","anyOf":[{"type":"string","maxLength":256,"pattern":"^\\$((\\.[A-Za-z0-9_-]+)|(\\[[0-9]{1,4}\\]))*$"},{"type":"null"}]},"input":{"description":"Send this constant text instead of the event","anyOf":[{"type":"string","maxLength":8192},{"type":"null"}]},"inputTransformer":{"description":"Send a template filled from the event: {\"inputPathsMap\": {\"state\": \"$.detail.state\"}, \"inputTemplate\": \"{\\\"id\\\": <$.detail.id>, \\\"msg\\\": \\\"now <state>\\\"}\"}","anyOf":[{"type":"object","properties":{"inputPathsMap":{"description":"Names for paths into the event, used as <name> in the template","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inputTemplate":{"type":"string","minLength":1,"description":"Text or JSON with placeholders: <$.detail.x>, <name> from inputPathsMap, <ews.events.event.json>, <ews.events.rule-name>, <ews.events.event-bus-name>, <ews.events.event-id>, <ews.events.replay-name>"}},"required":["inputTemplate"]},{"type":"null"}]},"retryMaxAttempts":{"description":"Retries after a failed attempt (default 185), never past maxEventAgeSeconds","type":"integer","minimum":0,"maximum":185},"maxEventAgeSeconds":{"description":"An event older than this is not attempted again (default 86400)","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed delivery is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]}},"required":["type","cluster","topic","id"]}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:PutRule","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["events:EnableRule","events:DisableRule","events:PutTargets","events:RemoveTargets","iam:PassRole","iam:GetAuditLogs"]},"delete":{"operationId":"events.rules.delete","summary":"Delete a rule and its delivery history","description":"`events:DeleteRule` Delete a rule and its delivery history.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DeleteRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/buses/{bus}/rules/{rule}/deliveries":{"get":{"operationId":"events.rules.deliveries","summary":"List a rule’s deliveries, newest first: event, target, status, attempts, the target’s answer","description":"`events:ListDeliveries` List a rule’s deliveries, newest first: event, target, status, attempts, the target’s answer.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","running","retry_wait","succeeded","failed","dead_lettered","dropped"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListDeliveries","x-ews-mutates":false,"x-ews-sensitive":false}},"/events/api/buses/{bus}/rules/{rule}/signing-secret":{"get":{"operationId":"events.rules.signing-secret","summary":"Reveal the secret HTTP targets are signed with (audited)","description":"`events:GetRuleSigningSecret` Reveal the secret HTTP targets are signed with (audited).","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:GetRuleSigningSecret","x-ews-mutates":false,"x-ews-sensitive":true}},"/events/api/buses/{bus}/rules/{rule}/signing-secret/rotate":{"post":{"operationId":"events.rules.rotate-signing-secret","summary":"Replace the signing secret; the previous one also signs for 24 hours","description":"`events:RotateRuleSigningSecret` Replace the signing secret; the previous one also signs for 24 hours.","tags":["Event bus"],"parameters":[{"name":"bus","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Event bus name (default is the platform’s own)"}},{"name":"rule","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Rule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:RotateRuleSigningSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/catalog":{"get":{"operationId":"events.patterns.catalog","summary":"List the events the platform sends to the default bus, with example patterns","description":"`events:ListEventBuses` List the events the platform sends to the default bus, with example patterns.","tags":["Event bus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListEventBuses","x-ews-mutates":false,"x-ews-sensitive":false}},"/events/api/replays":{"get":{"operationId":"events.replays.list","summary":"List replays (kept 7 days after they finish) with their progress","description":"`events:ListReplays` List replays (kept 7 days after they finish) with their progress.","tags":["Event bus"],"parameters":[{"name":"archive","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListReplays","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"events.replays.start","summary":"Replay an archive’s events from a time window into rules of its bus","description":"`events:StartReplay` Replay an archive’s events from a time window into rules of its bus. Events whose time is within [eventStartTime, eventEndTime] are sent in the order the bus received them, one at a time: the next only when every delivery of the previous is final. Each is matched against the rules’ CURRENT pattern; the envelope gains \"replay-name\". Replay deliveries retry at most 3 times within 5 minutes, then go to the target’s dead-letter queue (or fail) and the replay moves on. events:StartReplay is checked on the replay, the archive and each rule. One active replay per archive, 5 per organization (409).","tags":["Event bus"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"archive":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"The archive to replay from"},"eventStartTime":{"description":"Replay events whose time is at or after this"},"eventEndTime":{"description":"…and at or before this (not in the future)"},"rules":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"description":"Rules of the archive’s bus to replay into; their current pattern decides"}},"required":["name","archive","eventStartTime","eventEndTime","rules"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:StartReplay","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:GetAuditLogs"]}},"/events/api/replays/{replay}":{"get":{"operationId":"events.replays.get","summary":"Read a replay: state, eventsProcessed / eventsTotal, eventsReplayed","description":"`events:DescribeReplay` Read a replay: state, eventsProcessed / eventsTotal, eventsReplayed.","tags":["Event bus"],"parameters":[{"name":"replay","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Replay name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:DescribeReplay","x-ews-mutates":false,"x-ews-sensitive":false}},"/events/api/replays/{replay}/cancel":{"post":{"operationId":"events.replays.cancel","summary":"Cancel a replay; the event in flight finishes, no further one is sent","description":"`events:CancelReplay` Cancel a replay; the event in flight finishes, no further one is sent.","tags":["Event bus"],"parameters":[{"name":"replay","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Replay name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:CancelReplay","x-ews-mutates":true,"x-ews-sensitive":false}},"/events/api/sample-events":{"get":{"operationId":"events.patterns.samples","summary":"Recent API-call events of the organization as the bus would deliver them","description":"`events:ListEventBuses` Recent API-call events of the organization as the bus would deliver them.","tags":["Event bus"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":25,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:ListEventBuses","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:GetAuditLogs"]}},"/events/api/test-pattern":{"post":{"operationId":"events.patterns.test","summary":"Check whether an event matches a pattern","description":"`events:TestEventPattern` Check whether an event matches a pattern.","tags":["Event bus"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventPattern":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"EventBridge event pattern, e.g. {\"source\":[\"ews.ec2\"],\"detail\":{\"eventName\":[\"RunInstances\"]}}. Matchers: exact values, prefix, suffix, equals-ignore-case, anything-but, exists, numeric, wildcard (\"*\"); \"$or\": [{…}, {…}] at any level"},"event":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"An event envelope to test"}},"required":["eventPattern","event"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"events:TestEventPattern","x-ews-mutates":false,"x-ews-sensitive":false}},"/functions/api/functions":{"get":{"operationId":"functions.functions.list","summary":"List functions with their URLs and the instances running now","description":"`functions:ListFunctions` List functions with their URLs and the instances running now.","tags":["Functions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:ListFunctions","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"functions.functions.create","summary":"Create a function from source files","description":"`functions:CreateFunction` Create a function from source files. Node.js 22 (index.mjs): `export default async function (request) { return new Response(\"hi\") }` — a Fetch API Request in, a Response (or a string, or an object for JSON) out. Python 3.12 (main.py): `def handler(request): return {\"ok\": True}` — request has method, path, query, headers, body, text and json(); return a dict (JSON), str/bytes, None (204) or (status, headers, body). The function gets an HTTPS URL; an instance starts on the first call and stops after idleTimeoutSeconds without one (scale to zero). auth defaults to iam (the URL needs a Deutsche Cloud access key with functions:InvokeFunction); public needs functions:MakeFunctionPublic. 409 when the name is taken. Dependencies: with package-lock.json (and package.json) or requirements.txt in the files, a function host installs them first (npm ci --omit=dev, or pip install, from registry.npmjs.org / PyPI only, in a gVisor instance of the same runtime) into node_modules/ or .python_packages/. A new function waits in state building until then (failed if the build fails).","tags":["Functions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"runtime":{"type":"string","enum":["nodejs22","python3.12","image"]},"entrypoint":{"description":"The file the bootstrap loads (default index.mjs for Node.js, main.py for Python)","type":"string","maxLength":200},"files":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?!\\/)(?!.*(^|\\/)\\.\\.?(\\/|$))[A-Za-z0-9._@+-]+(\\/[A-Za-z0-9._@+-]+)*$"},"additionalProperties":{"type":"string"},"description":"Source files: path → UTF-8 content, e.g. {\"index.mjs\": \"export default () => \\\"hi\\\"\"}. Dependencies: include package-lock.json (with package.json) or requirements.txt and they are installed at deploy (npm ci --omit=dev / pip install, from the public registries) — the new code goes live once that build is ready. Or vendor them yourself (node_modules/, or Python packages: /code is on sys.path)."},"image":{"type":"string","minLength":1,"maxLength":512,"pattern":"^([a-z0-9.-]+\\/)?[a-z0-9][a-z0-9._/-]*(:[A-Za-z0-9_][A-Za-z0-9._-]{0,127}|@sha256:[a-f0-9]{64})?$","description":"runtime image: an image of your registry (repo:tag or repo@sha256:…), pinned to its digest when set. Its server must listen on $PORT (8080)"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"description":{"type":"string","maxLength":256},"memoryMb":{"description":"Memory per instance, 128–2048 MB (default 256); CPU is 1 vCPU per GB, at least 0.25","type":"integer","minimum":128,"maximum":2048},"timeoutSeconds":{"description":"Per request, default 30","type":"integer","minimum":1,"maximum":900},"concurrency":{"description":"Requests one instance handles at once (default 10 for Node.js, 1 for Python)","type":"integer","minimum":1,"maximum":100},"maxInstances":{"description":"Instances at most (default 10); further requests wait for a slot","type":"integer","minimum":1,"maximum":50},"idleTimeoutSeconds":{"description":"An instance stops after this long without a request (default 300): scale to zero","type":"integer","minimum":30,"maximum":3600},"auth":{"description":"iam (default): the URL needs Authorization: EWS-ACCESS-KEY with functions:InvokeFunction. public: anyone may call it (needs functions:MakeFunctionPublic)","type":"string","enum":["iam","public"]},"network":{"description":"open (default): the internet, minus private ranges, metadata and SMTP. none: no egress","type":"string","enum":["open","none"]},"env":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Z_][A-Z0-9_]*$"},"additionalProperties":{"type":"string","maxLength":4096},"description":"Plain environment variables (not secrets: they are readable with GetFunction)"},"secrets":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[A-Z_][A-Z0-9_]*$","description":"The environment variable, e.g. DATABASE_URL"},"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A secret of the Secrets service"}},"required":["name","secretId"]},"description":"Secrets as environment variables. Read when an instance starts (needs secrets:GetSecretValue to bind; binding grants the secret to compute consumers); never shown by GetFunction. The whole list replaces the previous one"},"roleName":{"description":"The IAM role the function acts as (needs iam:PassRole on it); its instances get a 60-minute session as EWS_ACCESS_KEY, which the Deutsche Cloud SDKs and CLI read. null removes it","anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"publicRateLimit":{"description":"Requests per second a public URL accepts (default 50)","type":"integer","minimum":1,"maximum":1000},"initSnapshot":{"description":"Start instances from an image taken right after your module loaded (default false): the first cold start of each version takes it, later ones skip the import. The image holds what your module computed at import, its env and secrets, on the function host only. Not a new version","type":"boolean"}},"required":["name","runtime"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:CreateFunction","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["functions:MakeFunctionPublic"]}},"/functions/api/functions/{name}":{"get":{"operationId":"functions.functions.get","summary":"Read a function: URL, limits, running instances and the last 24 hours of usage","description":"`functions:GetFunction` Read a function: URL, limits, running instances and the last 24 hours of usage.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:GetFunction","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"functions.functions.update","summary":"Change memory, timeout, concurrency, scaling, auth, network or environment","description":"`functions:UpdateFunctionConfiguration` Change memory, timeout, concurrency, scaling, auth, network or environment. Running instances finish their requests and are replaced by the new configuration.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","maxLength":256},"memoryMb":{"description":"Memory per instance, 128–2048 MB (default 256); CPU is 1 vCPU per GB, at least 0.25","type":"integer","minimum":128,"maximum":2048},"timeoutSeconds":{"description":"Per request, default 30","type":"integer","minimum":1,"maximum":900},"concurrency":{"description":"Requests one instance handles at once (default 10 for Node.js, 1 for Python)","type":"integer","minimum":1,"maximum":100},"maxInstances":{"description":"Instances at most (default 10); further requests wait for a slot","type":"integer","minimum":1,"maximum":50},"idleTimeoutSeconds":{"description":"An instance stops after this long without a request (default 300): scale to zero","type":"integer","minimum":30,"maximum":3600},"auth":{"description":"iam (default): the URL needs Authorization: EWS-ACCESS-KEY with functions:InvokeFunction. public: anyone may call it (needs functions:MakeFunctionPublic)","type":"string","enum":["iam","public"]},"network":{"description":"open (default): the internet, minus private ranges, metadata and SMTP. none: no egress","type":"string","enum":["open","none"]},"env":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Z_][A-Z0-9_]*$"},"additionalProperties":{"type":"string","maxLength":4096},"description":"Plain environment variables (not secrets: they are readable with GetFunction)"},"secrets":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[A-Z_][A-Z0-9_]*$","description":"The environment variable, e.g. DATABASE_URL"},"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A secret of the Secrets service"}},"required":["name","secretId"]},"description":"Secrets as environment variables. Read when an instance starts (needs secrets:GetSecretValue to bind; binding grants the secret to compute consumers); never shown by GetFunction. The whole list replaces the previous one"},"roleName":{"description":"The IAM role the function acts as (needs iam:PassRole on it); its instances get a 60-minute session as EWS_ACCESS_KEY, which the Deutsche Cloud SDKs and CLI read. null removes it","anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"publicRateLimit":{"description":"Requests per second a public URL accepts (default 50)","type":"integer","minimum":1,"maximum":1000},"initSnapshot":{"description":"Start instances from an image taken right after your module loaded (default false): the first cold start of each version takes it, later ones skip the import. The image holds what your module computed at import, its env and secrets, on the function host only. Not a new version","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:UpdateFunctionConfiguration","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["functions:MakeFunctionPublic"]},"delete":{"operationId":"functions.functions.delete","summary":"Delete a function; its instances stop","description":"`functions:DeleteFunction` Delete a function; its instances stop.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:DeleteFunction","x-ews-mutates":true,"x-ews-sensitive":false}},"/functions/api/functions/{name}/code":{"put":{"operationId":"functions.functions.deploy","summary":"Deploy new source files","description":"`functions:UpdateFunctionCode` Deploy new source files. Node.js 22 (index.mjs): `export default async function (request) { return new Response(\"hi\") }` — a Fetch API Request in, a Response (or a string, or an object for JSON) out. Python 3.12 (main.py): `def handler(request): return {\"ok\": True}` — request has method, path, query, headers, body, text and json(); return a dict (JSON), str/bytes, None (204) or (status, headers, body). The function gets an HTTPS URL; an instance starts on the first call and stops after idleTimeoutSeconds without one (scale to zero). The next request runs the new code. Dependencies: with package-lock.json (and package.json) or requirements.txt in the files, a function host installs them first (npm ci --omit=dev, or pip install, from registry.npmjs.org / PyPI only, in a gVisor instance of the same runtime) into node_modules/ or .python_packages/. Then the answer is 202 and the current code keeps serving until the build is ready; a failed build never goes live (its log is in get → build.log). The same lockfile reuses its build: 200 at once.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?!\\/)(?!.*(^|\\/)\\.\\.?(\\/|$))[A-Za-z0-9._@+-]+(\\/[A-Za-z0-9._@+-]+)*$"},"additionalProperties":{"type":"string"},"description":"Source files: path → UTF-8 content, e.g. {\"index.mjs\": \"export default () => \\\"hi\\\"\"}. Dependencies: include package-lock.json (with package.json) or requirements.txt and they are installed at deploy (npm ci --omit=dev / pip install, from the public registries) — the new code goes live once that build is ready. Or vendor them yourself (node_modules/, or Python packages: /code is on sys.path)."},"entrypoint":{"type":"string","maxLength":200},"image":{"type":"string","minLength":1,"maxLength":512,"pattern":"^([a-z0-9.-]+\\/)?[a-z0-9][a-z0-9._/-]*(:[A-Za-z0-9_][A-Za-z0-9._-]{0,127}|@sha256:[a-f0-9]{64})?$","description":"runtime image: an image of your registry (repo:tag or repo@sha256:…), pinned to its digest when set. Its server must listen on $PORT (8080)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:UpdateFunctionCode","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"functions.functions.code","summary":"Read the deployed source files (audited)","description":"`functions:GetFunctionCode` Read the deployed source files (audited).","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:GetFunctionCode","x-ews-mutates":false,"x-ews-sensitive":true}},"/functions/api/functions/{name}/event-source-mappings":{"get":{"operationId":"functions.event-source-mappings.list","summary":"List the queues a function consumes, with their state and counters","description":"`functions:ListEventSourceMappings` List the queues a function consumes, with their state and counters.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:ListEventSourceMappings","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"functions.event-source-mappings.create","summary":"Let a function consume a queue","description":"`functions:CreateEventSourceMapping` Let a function consume a queue. The function needs an execution role allowed queue:ReceiveMessage and queue:DeleteMessage on the queue. It is called with POST / and {\"records\":[{messageId, body, attributes, receiveCount, sentAt, queueName}]}. A 2xx deletes the batch, except the ids it answers in {\"failedMessageIds\":[...]}; anything else leaves the batch to reappear after the visibility timeout (at least once; the queue’s redrive policy moves it to its dead-letter queue). Every batch writes a TRIGGER line to the function’s logs.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"queueName":{"type":"string","minLength":1,"maxLength":80,"description":"A queue of the Queue service in the same region"},"batchSize":{"type":"integer","minimum":1,"maximum":10,"description":"Messages per invocation, 1–10 (default 10)"},"maxConcurrency":{"type":"integer","minimum":1,"maximum":10,"description":"Batches in flight at once, 1–10 (default 2); never more than maxInstances × concurrency"},"enabled":{"description":"Start consuming at once (default true)","type":"boolean"}},"required":["queueName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:CreateEventSourceMapping","x-ews-mutates":true,"x-ews-sensitive":false}},"/functions/api/functions/{name}/event-source-mappings/{id}":{"patch":{"operationId":"functions.event-source-mappings.update","summary":"Change a queue trigger, or pause and resume it (enabled)","description":"`functions:UpdateEventSourceMapping` Change a queue trigger, or pause and resume it (enabled).","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Queue trigger id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"batchSize":{"type":"integer","minimum":1,"maximum":10,"description":"Messages per invocation, 1–10 (default 10)"},"maxConcurrency":{"type":"integer","minimum":1,"maximum":10,"description":"Batches in flight at once, 1–10 (default 2); never more than maxInstances × concurrency"},"enabled":{"description":"false pauses the trigger; true resumes it","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:UpdateEventSourceMapping","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"functions.event-source-mappings.delete","summary":"Stop a function consuming a queue","description":"`functions:DeleteEventSourceMapping` Stop a function consuming a queue.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Queue trigger id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:DeleteEventSourceMapping","x-ews-mutates":true,"x-ews-sensitive":false}},"/functions/api/functions/{name}/invoke":{"post":{"operationId":"functions.functions.invoke","summary":"Call a function and return its answer (status, headers, body, cold start)","description":"`functions:InvokeFunction` Call a function and return its answer (status, headers, body, cold start). Works for iam and public functions alike. The body is returned as text, cut at 256 KB. Logs: monitoring logs with resourceType=function and resourceId=<function id>.","tags":["Functions"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$","description":"Function name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"default":"POST","type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},"path":{"default":"/","description":"Path and query string, e.g. /hello?name=ews","type":"string","maxLength":2048,"pattern":"^\\/"},"headers":{"type":"object","propertyNames":{"type":"string","maxLength":128},"additionalProperties":{"type":"string","maxLength":4096}},"body":{"description":"Request body; for JSON, a JSON string","type":"string","maxLength":1048576}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"functions:InvokeFunction","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/access-tokens":{"get":{"operationId":"git.access-tokens.list","summary":"List your git access tokens","description":"`git:ListAccessTokens` List your git access tokens.","tags":["Git"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The token id"},"orgId":{"type":"string","description":"The organization"},"iamUserId":{"type":"string","description":"The IAM user it acts as"},"name":{"type":"string","description":"Its name"},"tokenPrefix":{"type":"string","description":"The public part of the token, to recognise it by"},"lastUsedAt":{"description":"When it was last used (ISO 8601); null if never","type":["string","null"]},"expiresAt":{"description":"When it expires (ISO 8601); null for never","type":["string","null"]},"access":{"type":"string","enum":["read","write"],"description":"read: clone, fetch and API reads only; write: also push and writes"},"repositoryIds":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The repositories it works on; null for every repository you can reach"},"githubPermissions":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","enum":["read","write"]}},{"type":"null"}],"description":"A CI job token's permission scopes; null for a personal token"},"ciRunId":{"description":"The CI run a job token is for; null otherwise","type":["string","null"]},"ciJobId":{"description":"The CI job a job token is for; null otherwise","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"}},"required":["id","orgId","iamUserId","name","tokenPrefix","lastUsedAt","expiresAt","access","repositoryIds","githubPermissions","ciRunId","ciJobId","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListAccessTokens","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.access-tokens.create","summary":"Create a git access token and return it once","description":"`git:CreateAccessToken` Create a git access token and return it once.","tags":["Git"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A name to recognise the token by"},"expiresInDays":{"description":"Days until the token expires; it never expires when absent","type":"integer","minimum":1,"maximum":365},"access":{"description":"read: clone, fetch and API reads only; write (default): also push and writes","type":"string","enum":["read","write"]},"repositoryIds":{"description":"Only these repositories; omit for every repository you can reach","minItems":1,"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The token id"},"orgId":{"type":"string","description":"The organization"},"iamUserId":{"type":"string","description":"The IAM user it acts as"},"name":{"type":"string","description":"Its name"},"tokenPrefix":{"type":"string","description":"The public part of the token, to recognise it by"},"lastUsedAt":{"description":"When it was last used (ISO 8601); null if never","type":["string","null"]},"expiresAt":{"description":"When it expires (ISO 8601); null for never","type":["string","null"]},"access":{"type":"string","enum":["read","write"],"description":"read: clone, fetch and API reads only; write: also push and writes"},"repositoryIds":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The repositories it works on; null for every repository you can reach"},"githubPermissions":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","enum":["read","write"]}},{"type":"null"}],"description":"A CI job token's permission scopes; null for a personal token"},"ciRunId":{"description":"The CI run a job token is for; null otherwise","type":["string","null"]},"ciJobId":{"description":"The CI job a job token is for; null otherwise","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"token":{"type":"string","description":"The full token, shown this once and never again"}},"required":["id","orgId","iamUserId","name","tokenPrefix","lastUsedAt","expiresAt","access","repositoryIds","githubPermissions","ciRunId","ciJobId","createdAt","token"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateAccessToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/access-tokens/{id}":{"delete":{"operationId":"git.access-tokens.delete","summary":"Revoke a git access token","description":"`git:DeleteAccessToken` Revoke a git access token.","tags":["Git"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteAccessToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/attachments/{id}":{"get":{"operationId":"git.attachments.get","summary":"Fetch an attachment","description":"`git:GetRepository` Fetch an attachment. Access is re-checked against the repository the attachment belongs to, so losing repo access loses the attachment.","tags":["Git"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/github/installations":{"get":{"operationId":"git.github.list-installations","summary":"List connected GitHub accounts and the repositories each covers","description":"`git:ListGithubInstallations` List connected GitHub accounts and the repositories each covers.","tags":["Git"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"app":{"anyOf":[{"type":"object","properties":{"slug":{"type":"string","description":"The App's slug on GitHub (github.com/apps/{slug})"},"name":{"type":"string","description":"The App's name"},"host":{"type":"string","description":"The GitHub host it is registered on (github.com)"}},"required":["slug","name","host"],"additionalProperties":false},{"type":"null"}],"description":"The platform's GitHub App; null while it is not registered, and then `installations` is empty"},"installations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The installation here: the `{id}` of the other github operations"},"installationId":{"type":"number","description":"GitHub's id of the installation"},"account":{"type":"string","description":"The GitHub user or organization it is installed on"},"accountType":{"type":"string","description":"User or Organization, as GitHub says"},"repositorySelection":{"type":"string","enum":["all","selected"],"description":"Whether it covers all of the account’s repositories or a chosen few"},"suspended":{"type":"boolean","description":"Suspended on GitHub; nothing is listed or mirrored through it"},"error":{"description":"Why its repositories could not be listed (suspended, GitHub's answer); null when they were","type":["string","null"]},"repositories":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string","description":"owner/name on GitHub"},"private":{"type":"boolean","description":"Private on GitHub"},"archived":{"type":"boolean","description":"Archived on GitHub"},"defaultBranch":{"description":"Its default branch; null when GitHub did not say","type":["string","null"]},"htmlUrl":{"type":"string","description":"Its page on GitHub"},"mirroredAs":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The mirror repository here"},"name":{"type":"string","description":"Its name here"},"shadowCi":{"type":"boolean","description":"Shadow CI is on for it"},"shadowPaused":{"description":"Why shadow CI is paused (a cap reached); null when it is not","type":["string","null"]}},"required":["id","name","shadowCi","shadowPaused"],"additionalProperties":false},{"type":"null"}],"description":"The repository here that mirrors it; null when none does"}},"required":["fullName","private","archived","defaultBranch","htmlUrl","mirroredAs"],"additionalProperties":false},"description":"The repositories the installation covers now; empty when `error` is set"}},"required":["id","installationId","account","accountType","repositorySelection","suspended","error","repositories"],"additionalProperties":false},"description":"The organization's connected installations, by account name"}},"required":["app","installations"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListGithubInstallations","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/github/installations/{id}":{"delete":{"operationId":"git.github.disconnect-installation","summary":"Disconnect a GitHub account; its mirrors stop syncing","description":"`git:ConnectGithub` Disconnect a GitHub account; its mirrors stop syncing.","tags":["Git"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The installation disconnected"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConnectGithub","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/github/installations/{id}/mirror":{"post":{"operationId":"git.github.mirror","summary":"Mirror a GitHub repository the installation covers (no token kept)","description":"`git:ConnectGithub` Mirror a GitHub repository the installation covers (no token kept). Answers 202. Needs git:CreateRepository as well as git:ConnectGithub.","tags":["Git"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"repository":{"type":"string","description":"owner/name on GitHub"},"name":{"description":"Name here; GitHub’s name when omitted","type":"string"},"shadowCi":{"description":"Run its workflows here on every push to the default branch (capped)","type":"boolean"}},"required":["repository"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The new mirror repository"},"name":{"type":"string","description":"Its name here"}},"required":["id","name"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConnectGithub","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/github/repositories/{repoId}/push-back":{"put":{"operationId":"git.github.set-push-back","summary":"Push a repository back to GitHub after every push, through the App","description":"`git:ConfigurePushMirror` Push a repository back to GitHub after every push, through the App. Replaces any push mirror the repository had. Needs git:ConnectGithub as well.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"installation":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The installation (its id here)"},"repository":{"type":"string","description":"owner/name on GitHub to push to"}},"required":["installation","repository"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository that pushes back"},"url":{"type":"string","description":"The GitHub page of the repository it pushes to"}},"required":["id","url"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConfigurePushMirror","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/github/repositories/{repoId}/shadow-ci":{"put":{"operationId":"git.github.set-shadow-ci","summary":"Turn shadow CI on or off for a mirror (3,000 runner minutes a month per repository, 10,000 per organization, 2 runs at once)","description":"`git:UpdateRepository` Turn shadow CI on or off for a mirror (3,000 runner minutes a month per repository, 10,000 per organization, 2 runs at once).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true runs its workflows here on every mirrored push"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The mirror repository"},"shadowCi":{"type":"boolean","description":"Shadow CI is on"}},"required":["id","shadowCi"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories":{"get":{"operationId":"git.repositories.list","summary":"List repositories","description":"`git:ListRepositories` List repositories.","tags":["Git"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListRepositories","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.repositories.create","summary":"Create a repository","description":"`git:CreateRepository` Create a repository.","tags":["Git"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"Unique within the organization; part of the clone URL"},"description":{"description":"One line about the repository; the template's description when absent","type":"string","maxLength":500},"visibility":{"description":"Who can see it; private when absent. public also needs git:PublishRepository","type":"string","enum":["private","internal","public"]},"defaultBranch":{"description":"The branch clones check out and pull requests target by default; main when absent","type":"string","minLength":1,"maxLength":100},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"template":{"description":"Start from a template: one commit with its files, no history (CI runs on it)","type":"object","properties":{"repository":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}\\/[A-Za-z0-9._-]{1,100}$"}],"description":"A repository id of this organization, or org/name of a public repository"},"ref":{"description":"Branch or tag of the template; default: the template's default branch","type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9._/-]+$"}},"required":["repository"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}":{"get":{"operationId":"git.repositories.get","summary":"Describe one repository","description":"`git:GetRepository` Describe one repository.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"git.repositories.update","summary":"Change description, visibility, default branch or archive state","description":"`git:UpdateRepository` Change description, visibility, default branch or archive state.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"One line about the repository, shown in lists and the About column","type":"string","maxLength":500},"homepage":{"description":"The About link (http or https); null removes it","anyOf":[{"type":"string","maxLength":300,"format":"uri"},{"type":"null"}]},"topics":{"description":"Topics: lowercase letters, digits and hyphens, at most 20","maxItems":20,"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,49}$"}},"visibility":{"description":"Who can see it; making it public also needs git:PublishRepository","type":"string","enum":["private","internal","public"]},"defaultBranch":{"description":"The branch clones check out and pull requests target by default","type":"string","minLength":1,"maxLength":100},"isArchived":{"description":"true archives it (read-only: pushes, merges and edits refused); false unarchives","type":"boolean"},"allowMergeCommit":{"description":"Pull requests may merge with a merge commit","type":"boolean"},"allowSquashMerge":{"description":"Pull requests may be squash-merged","type":"boolean"},"allowRebaseMerge":{"description":"Pull requests may be rebase-merged","type":"boolean"},"deleteBranchOnMerge":{"description":"Delete the source branch when a pull request is merged","type":"boolean"},"defaultWorkflowPermissions":{"description":"What a workflow job's GITHUB_TOKEN may do when its file sets no `permissions:`: restricted (contents and packages read; new repositories) or permissive (read and write)","type":"string","enum":["restricted","permissive"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.repositories.delete","summary":"Delete a repository","description":"`git:DeleteRepository` Delete a repository.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/archive":{"get":{"operationId":"git.files.archive","summary":"Download the tree at a ref as an archive","description":"`git:PullRepository` Download the tree at a ref as an archive.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"The branch, tag or commit id whose files to pack"}},{"name":"format","in":"query","required":false,"schema":{"description":"The archive format; zip when absent","type":"string","enum":["zip","tar.gz"]}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/blame":{"get":{"operationId":"git.files.blame","summary":"Which commit last changed each line of a file","description":"`git:PullRepository` Which commit last changed each line of a file. Hunks of consecutive lines from one commit: the commit (oid, summary, author, authorTime in seconds), the first line number and the lines.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1000,"description":"The file's path from the repository root, e.g. src/index.ts"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"commit":{"type":"object","properties":{"oid":{"type":"string","description":"The commit that last changed these lines"},"summary":{"type":"string","description":"The first line of that commit's message"},"author":{"type":"string","description":"The commit's author"},"authorEmail":{"type":"string","description":"The author's email address"},"authorTime":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"When it was authored, in seconds since the epoch"}},"required":["oid","summary","author","authorEmail","authorTime"],"additionalProperties":false,"description":"The commit the lines come from"},"startLine":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"1-based line number of the hunk's first line"},"lines":{"type":"array","items":{"type":"string"},"description":"The lines of the hunk, in order"}},"required":["commit","startLine","lines"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/blob":{"get":{"operationId":"git.files.blob","summary":"Read one file as raw text","description":"`git:PullRepository` Read one file as raw text.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1000,"description":"The file's path from the repository root, e.g. src/index.ts"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"oid":{"type":"string","description":"The object id of the file content"},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size in bytes"},"isBinary":{"type":"boolean","description":"true when the file is not text"},"text":{"description":"The content as UTF-8; null for a binary file","type":["string","null"]}},"required":["oid","size","isBinary","text"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/branch-protection":{"get":{"operationId":"git.branch-protection.list","summary":"List branch protection rules","description":"`git:GetRepository` List branch protection rules.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The rule's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"branchPattern":{"type":"string","description":"The branch name or glob the rule covers"},"requirePullRequest":{"type":"boolean","description":"Changes must land through a pull request"},"requiredApprovals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Approvals a pull request needs to merge"},"dismissStaleApprovals":{"type":"boolean","description":"A new push withdraws earlier approvals"},"requireCodeOwnerReview":{"type":"boolean","description":"Every changed file CODEOWNERS assigns needs an approval from one of its owners"},"requireStatusChecks":{"type":"boolean","description":"Required checks must pass before a merge"},"requiredChecks":{"type":"array","items":{"type":"string"},"description":"Checks that must pass, by workflow or status context name; empty means every workflow a pull request triggers"},"blockForcePush":{"type":"boolean","description":"Pushes that rewrite the branch history are refused"},"blockDeletion":{"type":"boolean","description":"Deleting the branch is refused"},"requireMergeQueue":{"type":"boolean","description":"The branch moves only through the merge queue; direct pushes and merges are refused"},"mergeQueueMethod":{"type":"string","enum":["merge","squash","rebase"],"description":"How the queue merges each pull request"},"mergeQueueBuildConcurrency":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many queued pull requests may be building at once"},"mergeQueueMinGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Fewest pull requests to wait for before the first build starts"},"mergeQueueMaxGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most pull requests landed by one fast-forward"},"mergeQueueWaitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes to wait for the minimum group size before building anyway"},"mergeQueueCheckTimeoutMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes a queue build may wait for its checks before it fails"},"mergeQueueOnlyNonFailing":{"type":"boolean","description":"Only pull requests whose own build passed land; off lets a later passing build carry them"},"createdAt":{"type":"string","description":"When the rule was added (ISO 8601)"},"updatedAt":{"type":"string","description":"When the rule was last changed (ISO 8601)"}},"required":["id","orgId","repoId","branchPattern","requirePullRequest","requiredApprovals","dismissStaleApprovals","requireCodeOwnerReview","requireStatusChecks","requiredChecks","blockForcePush","blockDeletion","requireMergeQueue","mergeQueueMethod","mergeQueueBuildConcurrency","mergeQueueMinGroupSize","mergeQueueMaxGroupSize","mergeQueueWaitMinutes","mergeQueueCheckTimeoutMinutes","mergeQueueOnlyNonFailing","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.branch-protection.create","summary":"Add a branch protection rule","description":"`git:ManageBranchProtection` Add a branch protection rule.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchPattern":{"type":"string","minLength":1,"maxLength":200,"description":"The branch name or glob the rule covers, e.g. main or release/*"},"requirePullRequest":{"type":"boolean","description":"Changes land only through a pull request; direct pushes are refused (true on a new rule)"},"requiredApprovals":{"type":"integer","minimum":0,"maximum":10,"description":"Approvals a pull request needs before it can merge (0 on a new rule)"},"dismissStaleApprovals":{"type":"boolean","description":"A push to the pull request dismisses the approvals given before it (false on a new rule)"},"requireCodeOwnerReview":{"type":"boolean","description":"Every changed file CODEOWNERS assigns needs an approval from one of its owners"},"requireStatusChecks":{"type":"boolean","description":"Required checks must pass before a pull request can merge (false on a new rule)"},"requiredChecks":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"description":"Workflow or status names that must pass; empty means every workflow a pull request to the branch triggers"},"blockForcePush":{"type":"boolean","description":"Refuse pushes that rewrite the branch history (true on a new rule)"},"blockDeletion":{"type":"boolean","description":"Refuse deleting the branch (true on a new rule)"},"requireMergeQueue":{"type":"boolean","description":"The branch moves only through its merge queue; direct pushes and the merge button are refused (false on a new rule)"},"mergeQueueMethod":{"type":"string","enum":["merge","squash","rebase"],"description":"How the queue merges each pull request (merge on a new rule)"},"mergeQueueBuildConcurrency":{"type":"integer","minimum":1,"maximum":100,"description":"How many queued pull requests may be building at once (5 on a new rule)"},"mergeQueueMinGroupSize":{"type":"integer","minimum":1,"maximum":100,"description":"Fewest pull requests the queue waits for before it builds, up to the wait time (1 on a new rule)"},"mergeQueueMaxGroupSize":{"type":"integer","minimum":1,"maximum":100,"description":"Most pull requests landed by one fast-forward (5 on a new rule)"},"mergeQueueWaitMinutes":{"type":"integer","minimum":0,"maximum":360,"description":"Minutes to wait for the minimum group size before building anyway (5 on a new rule)"},"mergeQueueCheckTimeoutMinutes":{"type":"integer","minimum":1,"maximum":360,"description":"Minutes a queue build may wait for its checks before it fails (60 on a new rule)"},"mergeQueueOnlyNonFailing":{"type":"boolean","description":"Land only pull requests whose own build passed; off, a failed build still lands if a later build containing it passes (true on a new rule)"}},"required":["branchPattern"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The rule's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"branchPattern":{"type":"string","description":"The branch name or glob the rule covers"},"requirePullRequest":{"type":"boolean","description":"Changes must land through a pull request"},"requiredApprovals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Approvals a pull request needs to merge"},"dismissStaleApprovals":{"type":"boolean","description":"A new push withdraws earlier approvals"},"requireCodeOwnerReview":{"type":"boolean","description":"Every changed file CODEOWNERS assigns needs an approval from one of its owners"},"requireStatusChecks":{"type":"boolean","description":"Required checks must pass before a merge"},"requiredChecks":{"type":"array","items":{"type":"string"},"description":"Checks that must pass, by workflow or status context name; empty means every workflow a pull request triggers"},"blockForcePush":{"type":"boolean","description":"Pushes that rewrite the branch history are refused"},"blockDeletion":{"type":"boolean","description":"Deleting the branch is refused"},"requireMergeQueue":{"type":"boolean","description":"The branch moves only through the merge queue; direct pushes and merges are refused"},"mergeQueueMethod":{"type":"string","enum":["merge","squash","rebase"],"description":"How the queue merges each pull request"},"mergeQueueBuildConcurrency":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many queued pull requests may be building at once"},"mergeQueueMinGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Fewest pull requests to wait for before the first build starts"},"mergeQueueMaxGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most pull requests landed by one fast-forward"},"mergeQueueWaitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes to wait for the minimum group size before building anyway"},"mergeQueueCheckTimeoutMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes a queue build may wait for its checks before it fails"},"mergeQueueOnlyNonFailing":{"type":"boolean","description":"Only pull requests whose own build passed land; off lets a later passing build carry them"},"createdAt":{"type":"string","description":"When the rule was added (ISO 8601)"},"updatedAt":{"type":"string","description":"When the rule was last changed (ISO 8601)"}},"required":["id","orgId","repoId","branchPattern","requirePullRequest","requiredApprovals","dismissStaleApprovals","requireCodeOwnerReview","requireStatusChecks","requiredChecks","blockForcePush","blockDeletion","requireMergeQueue","mergeQueueMethod","mergeQueueBuildConcurrency","mergeQueueMinGroupSize","mergeQueueMaxGroupSize","mergeQueueWaitMinutes","mergeQueueCheckTimeoutMinutes","mergeQueueOnlyNonFailing","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageBranchProtection","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/branch-protection/{ruleId}":{"patch":{"operationId":"git.branch-protection.update","summary":"Change a branch protection rule","description":"`git:ManageBranchProtection` Change a branch protection rule. Only the fields sent are written. Editing in place matters because the alternative — create the replacement, delete the old one — leaves the branch unprotected in between.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchPattern":{"type":"string","minLength":1,"maxLength":200,"description":"The branch name or glob the rule covers, e.g. main or release/*"},"requirePullRequest":{"type":"boolean","description":"Changes land only through a pull request; direct pushes are refused (true on a new rule)"},"requiredApprovals":{"type":"integer","minimum":0,"maximum":10,"description":"Approvals a pull request needs before it can merge (0 on a new rule)"},"dismissStaleApprovals":{"type":"boolean","description":"A push to the pull request dismisses the approvals given before it (false on a new rule)"},"requireCodeOwnerReview":{"type":"boolean","description":"Every changed file CODEOWNERS assigns needs an approval from one of its owners"},"requireStatusChecks":{"type":"boolean","description":"Required checks must pass before a pull request can merge (false on a new rule)"},"requiredChecks":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"description":"Workflow or status names that must pass; empty means every workflow a pull request to the branch triggers"},"blockForcePush":{"type":"boolean","description":"Refuse pushes that rewrite the branch history (true on a new rule)"},"blockDeletion":{"type":"boolean","description":"Refuse deleting the branch (true on a new rule)"},"requireMergeQueue":{"type":"boolean","description":"The branch moves only through its merge queue; direct pushes and the merge button are refused (false on a new rule)"},"mergeQueueMethod":{"type":"string","enum":["merge","squash","rebase"],"description":"How the queue merges each pull request (merge on a new rule)"},"mergeQueueBuildConcurrency":{"type":"integer","minimum":1,"maximum":100,"description":"How many queued pull requests may be building at once (5 on a new rule)"},"mergeQueueMinGroupSize":{"type":"integer","minimum":1,"maximum":100,"description":"Fewest pull requests the queue waits for before it builds, up to the wait time (1 on a new rule)"},"mergeQueueMaxGroupSize":{"type":"integer","minimum":1,"maximum":100,"description":"Most pull requests landed by one fast-forward (5 on a new rule)"},"mergeQueueWaitMinutes":{"type":"integer","minimum":0,"maximum":360,"description":"Minutes to wait for the minimum group size before building anyway (5 on a new rule)"},"mergeQueueCheckTimeoutMinutes":{"type":"integer","minimum":1,"maximum":360,"description":"Minutes a queue build may wait for its checks before it fails (60 on a new rule)"},"mergeQueueOnlyNonFailing":{"type":"boolean","description":"Land only pull requests whose own build passed; off, a failed build still lands if a later build containing it passes (true on a new rule)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The rule's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"branchPattern":{"type":"string","description":"The branch name or glob the rule covers"},"requirePullRequest":{"type":"boolean","description":"Changes must land through a pull request"},"requiredApprovals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Approvals a pull request needs to merge"},"dismissStaleApprovals":{"type":"boolean","description":"A new push withdraws earlier approvals"},"requireCodeOwnerReview":{"type":"boolean","description":"Every changed file CODEOWNERS assigns needs an approval from one of its owners"},"requireStatusChecks":{"type":"boolean","description":"Required checks must pass before a merge"},"requiredChecks":{"type":"array","items":{"type":"string"},"description":"Checks that must pass, by workflow or status context name; empty means every workflow a pull request triggers"},"blockForcePush":{"type":"boolean","description":"Pushes that rewrite the branch history are refused"},"blockDeletion":{"type":"boolean","description":"Deleting the branch is refused"},"requireMergeQueue":{"type":"boolean","description":"The branch moves only through the merge queue; direct pushes and merges are refused"},"mergeQueueMethod":{"type":"string","enum":["merge","squash","rebase"],"description":"How the queue merges each pull request"},"mergeQueueBuildConcurrency":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many queued pull requests may be building at once"},"mergeQueueMinGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Fewest pull requests to wait for before the first build starts"},"mergeQueueMaxGroupSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most pull requests landed by one fast-forward"},"mergeQueueWaitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes to wait for the minimum group size before building anyway"},"mergeQueueCheckTimeoutMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes a queue build may wait for its checks before it fails"},"mergeQueueOnlyNonFailing":{"type":"boolean","description":"Only pull requests whose own build passed land; off lets a later passing build carry them"},"createdAt":{"type":"string","description":"When the rule was added (ISO 8601)"},"updatedAt":{"type":"string","description":"When the rule was last changed (ISO 8601)"}},"required":["id","orgId","repoId","branchPattern","requirePullRequest","requiredApprovals","dismissStaleApprovals","requireCodeOwnerReview","requireStatusChecks","requiredChecks","blockForcePush","blockDeletion","requireMergeQueue","mergeQueueMethod","mergeQueueBuildConcurrency","mergeQueueMinGroupSize","mergeQueueMaxGroupSize","mergeQueueWaitMinutes","mergeQueueCheckTimeoutMinutes","mergeQueueOnlyNonFailing","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageBranchProtection","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.branch-protection.delete","summary":"Remove a branch protection rule","description":"`git:ManageBranchProtection` Remove a branch protection rule.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageBranchProtection","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/branches":{"get":{"operationId":"git.branches.list","summary":"List branches","description":"`git:GetRepository` List branches.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The branch name, e.g. main or feature/login"},"oid":{"type":"string","description":"The commit id at the tip of the branch"},"isDefault":{"type":"boolean","description":"true for the repository's default branch"},"subject":{"type":"string","description":"The first line of the tip commit's message"},"authorName":{"type":"string","description":"Who wrote the tip commit"},"authoredAt":{"type":"string","description":"When the tip commit was authored (ISO 8601)"}},"required":["name","oid","isDefault","subject","authorName","authoredAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.branches.create","summary":"Create a branch from a ref","description":"`git:PushRepository` Create a branch from a ref. Writing through the console is the same act as pushing, so every write route needs git:PushRepository.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The new branch"},"from":{"type":"string","minLength":1,"maxLength":255,"description":"The branch, tag or commit id it starts at"}},"required":["name","from"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"The new branch"},"oid":{"type":"string","description":"The commit id it points at"}},"required":["name","oid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/branches/{name}":{"delete":{"operationId":"git.branches.delete","summary":"Delete a branch","description":"`git:PushRepository` Delete a branch. The route matches this segment as `:name{.+}` so branch names containing slashes survive; the value is URL-encoded on the wire.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"The ref that was deleted"}},"required":["name"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/code-scanning/sarifs":{"post":{"operationId":"git.security.upload-sarif","summary":"Upload a SARIF 2.1.0 file of code scanning results for a commit","description":"`git:UploadCodeScanningResults` Upload a SARIF 2.1.0 file of code scanning results for a commit. Any SARIF-writing tool (Semgrep, CodeQL, Trivy, gosec). An analysis of the default branch updates the repository’s alerts and marks those it no longer reports fixed; an analysis of a pull request’s head shows on the pull request.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"commitSha":{"type":"string","pattern":"^[0-9a-f]{40}$","description":"The commit the analysis ran on"},"ref":{"type":"string","minLength":1,"maxLength":255,"description":"The ref analysed: refs/heads/<branch>, or refs/pull/<n>/head for a pull request"},"sarif":{"type":"string","minLength":2,"maxLength":12582912,"description":"The SARIF 2.1.0 document, as JSON text (at most 12 MB)"}},"required":["commitSha","ref","sarif"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"analyses":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","description":"The tool of this run, e.g. Semgrep"},"analysisId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The analysis recorded for it"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Alerts it reports open"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Alerts it marked fixed by no longer reporting them"}},"required":["tool","analysisId","open","fixed"],"additionalProperties":false},"description":"One entry per tool run in the file"}},"required":["analyses"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UploadCodeScanningResults","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/commits":{"get":{"operationId":"git.commits.list","summary":"List commits on a ref","description":"`git:GetRepository` List commits on a ref. Metadata only, which is why this needs GetRepository rather than PullRepository.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id whose history to list; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":false,"schema":{"description":"Only commits that changed this file or directory","type":"string","maxLength":1000}},{"name":"limit","in":"query","required":false,"schema":{"description":"How many commits to return, newest first; 50 when absent","type":"integer","minimum":1,"maximum":200}},{"name":"skip","in":"query","required":false,"schema":{"description":"How many of the newest commits to skip, for paging; 0 when absent","type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","description":"The full 40-character commit id"},"shortOid":{"type":"string","description":"The abbreviated commit id"},"subject":{"type":"string","description":"The first line of the commit message"},"body":{"type":"string","description":"The rest of the commit message; empty when there is none"},"authorName":{"type":"string","description":"Who wrote the commit"},"authorEmail":{"type":"string","description":"The author's email address"},"authoredAt":{"type":"string","description":"When the commit was authored (ISO 8601)"},"parents":{"type":"array","items":{"type":"string"},"description":"Ids of the parent commits: none for the first commit, two or more for a merge"}},"required":["oid","shortOid","subject","body","authorName","authorEmail","authoredAt","parents"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.commits.create","summary":"Commit file edits to a branch","description":"`git:PushRepository` Commit file edits to a branch.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branch":{"type":"string","minLength":1,"maxLength":255,"description":"The branch to commit to; it must exist, except the default branch of an empty repository"},"message":{"type":"string","minLength":1,"maxLength":2000,"description":"The commit message"},"expectedOid":{"description":"Refuse (409) unless the branch is still at this commit, so an edit cannot overwrite a push","type":"string","pattern":"^[0-9a-f]{40}$"},"changes":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"upsert"},"path":{"type":"string","minLength":1,"maxLength":1000},"content":{"type":"string","maxLength":2000000}},"required":["kind","path","content"]},{"type":"object","properties":{"kind":{"type":"string","const":"delete"},"path":{"type":"string","minLength":1,"maxLength":1000}},"required":["kind","path"]}]},"description":"The file changes, applied in order: `upsert` writes `content` (the whole file, UTF-8) to `path`, `delete` removes `path`"}},"required":["branch","message","changes"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"commitOid":{"type":"string","description":"The new commit, now the tip of the branch"}},"required":["commitOid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/commits/{sha}":{"get":{"operationId":"git.commits.get","summary":"Show one commit with its patch","description":"`git:PullRepository` Show one commit with its patch. Sensitive read — a patch is source code.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"oid":{"type":"string","description":"The full 40-character commit id"},"shortOid":{"type":"string","description":"The abbreviated commit id"},"subject":{"type":"string","description":"The first line of the commit message"},"body":{"type":"string","description":"The rest of the commit message; empty when there is none"},"authorName":{"type":"string","description":"Who wrote the commit"},"authorEmail":{"type":"string","description":"The author's email address"},"authoredAt":{"type":"string","description":"When the commit was authored (ISO 8601)"},"parents":{"type":"array","items":{"type":"string"},"description":"Ids of the parent commits: none for the first commit, two or more for a merge"},"files":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"The file's path after the commit (the new path of a rename)"},"status":{"type":"string","enum":["added","modified","deleted","renamed"],"description":"What the commit did to the file"},"additions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines added (0 for a binary file)"},"deletions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines removed (0 for a binary file)"},"patch":{"description":"The file's unified diff; absent when there is none to show (e.g. too large)","type":"string"}},"required":["filename","status","additions","deletions"],"additionalProperties":false},"description":"Every file the commit changed"},"stats":{"type":"object","properties":{"additions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines added across all files"},"deletions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines removed across all files"}},"required":["additions","deletions"],"additionalProperties":false,"description":"Totals over the changed files"}},"required":["oid","shortOid","subject","body","authorName","authorEmail","authoredAt","parents","files","stats"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/commits/{sha}/code-scanning":{"get":{"operationId":"git.security.code-scanning-at-commit","summary":"Code scanning results reported for one commit, per tool","description":"`git:ListSecurityAlerts` Code scanning results reported for one commit, per tool.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{40}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","description":"The tool, e.g. Semgrep"},"analysedAt":{"type":"string","description":"When its latest analysis was uploaded (ISO 8601)"},"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"tool":{"type":"string","description":"The tool that reported it, e.g. Semgrep"},"fingerprint":{"type":"string","description":"Identifies the same finding across uploads"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once an analysis of the default branch no longer reports it"},"ruleId":{"type":"string","description":"The tool's rule id"},"ruleDescription":{"description":"The rule's description; null when the tool gives none","type":["string","null"]},"severity":{"type":"string","enum":["critical","high","medium","low","note"],"description":"The severity"},"message":{"type":"string","description":"What the tool says about this finding"},"path":{"type":"string","description":"The file, from the repository root"},"startLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"First line of the finding; null when not given"},"endLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Last line of the finding; null when not given"},"helpUri":{"description":"A link to the rule's documentation; null when none","type":["string","null"]},"firstSeenCommitOid":{"type":"string","description":"The commit it was first reported on"},"lastSeenCommitOid":{"type":"string","description":"The commit it was last reported on"},"lastSeenRef":{"type":"string","description":"The ref of the analysis that last saw it: the default branch or a pull request head"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When it was found fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first reported (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","tool","fingerprint","state","ruleId","ruleDescription","severity","message","path","startLine","endLine","helpUri","firstSeenCommitOid","lastSeenCommitOid","lastSeenRef","dismissedReason","dismissedByIamUserId","fixedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"The alerts that analysis reported"}},"required":["tool","analysedAt","alerts"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/commits/{sha}/statuses":{"get":{"operationId":"git.commit-statuses.list","summary":"Statuses reported on a commit","description":"`git:ListCommitStatuses` Statuses reported on a commit.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{40}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The status's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"commitOid":{"type":"string","description":"The commit the status is reported on"},"context":{"type":"string","description":"The name of the check; one status per context and commit"},"state":{"type":"string","enum":["pending","success","failure","error"],"description":"The result: pending waits, success passes, failure and error block"},"description":{"description":"A short summary; null when none was given","type":["string","null"]},"targetUrl":{"description":"A link to the details; null when none was given","type":["string","null"]},"creatorIamUserId":{"description":"The IAM user who reported it; null when that user has been deleted","type":["string","null"]},"createdAt":{"type":"string","description":"When the context was first reported on this commit (ISO 8601)"},"updatedAt":{"type":"string","description":"When it was last reported (ISO 8601)"}},"required":["id","orgId","repoId","commitOid","context","state","description","targetUrl","creatorIamUserId","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListCommitStatuses","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.commit-statuses.create","summary":"Report a status on a commit (one per context; a later one replaces it)","description":"`git:CreateCommitStatus` Report a status on a commit (one per context; a later one replaces it). GitHub’s POST /repos/{owner}/{repo}/statuses/{sha}. A branch protection rule whose required checks name this context waits for it: pending waits, success passes, failure and error block.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{40}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["pending","success","failure","error"],"description":"The result: pending waits, success passes, failure and error block a required check"},"context":{"default":"default","description":"Names the check; a required check of this name gates merges","type":"string","minLength":1,"maxLength":255},"description":{"description":"A short summary shown beside the status","type":"string","maxLength":1000},"targetUrl":{"description":"An https:// link to the details","type":"string","maxLength":2000}},"required":["state"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The status's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"commitOid":{"type":"string","description":"The commit the status is reported on"},"context":{"type":"string","description":"The name of the check; one status per context and commit"},"state":{"type":"string","enum":["pending","success","failure","error"],"description":"The result: pending waits, success passes, failure and error block"},"description":{"description":"A short summary; null when none was given","type":["string","null"]},"targetUrl":{"description":"A link to the details; null when none was given","type":["string","null"]},"creatorIamUserId":{"description":"The IAM user who reported it; null when that user has been deleted","type":["string","null"]},"createdAt":{"type":"string","description":"When the context was first reported on this commit (ISO 8601)"},"updatedAt":{"type":"string","description":"When it was last reported (ISO 8601)"}},"required":["id","orgId","repoId","commitOid","context","state","description","targetUrl","creatorIamUserId","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateCommitStatus","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/compare":{"get":{"operationId":"git.commits.compare","summary":"Diff two refs","description":"`git:PullRepository` Diff two refs.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"base","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"The ref the change is measured against, e.g. the target branch"}},{"name":"head","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"The ref with the changes; the diff is what it adds since its merge base"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"patch":{"type":"string","description":"A unified diff of what `head` adds since its merge base with `base`"},"filesChanged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Files that differ"},"insertions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines added"},"deletions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Lines removed"},"truncated":{"type":"boolean","description":"true when the patch holds only the first files: the whole diff is over 4 MiB"}},"required":["patch","filesChanged","insertions","deletions","truncated"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/deploy-keys":{"get":{"operationId":"git.deploy-keys.list","summary":"List deploy keys","description":"`git:ListDeployKeys` List deploy keys.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The key's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"name":{"type":"string","description":"The name the key was given"},"publicKey":{"type":"string","description":"The OpenSSH public key line"},"fingerprint":{"type":"string","description":"The key's SHA256 fingerprint, as `ssh-keygen -l` shows it"},"readOnly":{"type":"boolean","description":"true: clone and fetch only; false: it may push too"},"lastUsedAt":{"description":"When the key last opened the repository (ISO 8601); null when never","type":["string","null"]},"createdAt":{"type":"string","description":"When the key was added (ISO 8601)"}},"required":["id","orgId","repoId","name","publicKey","fingerprint","readOnly","lastUsedAt","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListDeployKeys","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.deploy-keys.create","summary":"Add a deploy key","description":"`git:CreateDeployKey` Add a deploy key.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A name to recognise the key by, e.g. the machine"},"publicKey":{"type":"string","minLength":1,"maxLength":4000,"description":"The OpenSSH public key line, e.g. `ssh-ed25519 AAAA… comment`"},"readOnly":{"description":"true lets the key clone and fetch only; false also lets it push. true when absent","type":"boolean"}},"required":["name","publicKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The key's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"name":{"type":"string","description":"The name the key was given"},"publicKey":{"type":"string","description":"The OpenSSH public key line"},"fingerprint":{"type":"string","description":"The key's SHA256 fingerprint, as `ssh-keygen -l` shows it"},"readOnly":{"type":"boolean","description":"true: clone and fetch only; false: it may push too"},"lastUsedAt":{"description":"When the key last opened the repository (ISO 8601); null when never","type":["string","null"]},"createdAt":{"type":"string","description":"When the key was added (ISO 8601)"}},"required":["id","orgId","repoId","name","publicKey","fingerprint","readOnly","lastUsedAt","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateDeployKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/deploy-keys/{keyId}":{"delete":{"operationId":"git.deploy-keys.delete","summary":"Remove a deploy key","description":"`git:DeleteDeployKey` Remove a deploy key.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteDeployKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/fork":{"post":{"operationId":"git.repositories.fork","summary":"Fork a repository of the organization","description":"`git:CreateRepository` Fork a repository of the organization. Answers 202 with the new repository (private, `forkedFromRepoId` set); every branch and tag is copied by a job, whose progress is `importState`. Needs git:PullRepository on the parent.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"The new repository, in the same organization"},"description":{"description":"One line about the fork; the parent's description when absent","type":"string","maxLength":500},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateRepository","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-soft-action":"git:PullRepository"}},"/git/api/repositories/{repoId}/highlighted":{"get":{"operationId":"git.files.highlighted","summary":"One file as lines with syntax highlighting","description":"`git:PullRepository` One file as lines with syntax highlighting. `lines` is the text split into lines; `html` one highlighted HTML fragment per line (both themes as CSS variables), or null when the file is over 512 KiB or has no known language.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1000,"description":"The file's path from the repository root, e.g. src/index.ts"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string"},"description":"The file's text split into lines"},"html":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"One highlighted HTML fragment per line; null when the file is over 512 KiB or its language is unknown"}},"required":["lines","html"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/import":{"get":{"operationId":"git.repositories.get-import","summary":"How far an import has come: phase, branches, tags and pull requests so far, started and finished, or why it failed","description":"`git:GetRepository` How far an import has come: phase, branches, tags and pull requests so far, started and finished, or why it failed.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"phase":{"type":"string","enum":["waiting","history","pull-requests","finishing","done","failed"],"description":"What it is doing: waiting, fetching history, pull requests, finishing"},"sourceUrl":{"type":"string","description":"The source, without credentials"},"includesPullRequests":{"type":"boolean","description":"Pull requests are brought over"},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches here so far"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags here so far"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests here so far"},"error":{"description":"Why it failed; null unless it did","type":["string","null"]}},"required":["status","phase","sourceUrl","includesPullRequests","startedAt","finishedAt","branches","tags","pullRequests","error"],"additionalProperties":false},{"type":"null"}],"description":"The progress; null for a repository that was not imported"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/import/retry":{"post":{"operationId":"git.repositories.retry-import","summary":"Start a failed import again from the same source","description":"`git:UpdateRepository` Start a failed import again from the same source. Answers 202. A mirror reuses the token it keeps; a private source needs `token`.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"description":"A token for a private source; a mirror reuses the one it keeps","type":"string","minLength":1,"maxLength":1000}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/insights":{"get":{"operationId":"git.files.insights","summary":"Commits per week, contributors and pull request activity","description":"`git:GetRepository` Commits per week, contributors and pull request activity. On the default branch over the last 52 weeks: `weeks` (weekStart Monday UTC, commits), `contributors` (name, email, commits) and `commitsInYear`; `pullRequests` counts opened, merged and closed in the last 30 days and open now.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"weeks":{"type":"array","items":{"type":"object","properties":{"weekStart":{"type":"string","description":"Monday of the week (UTC), as YYYY-MM-DD"},"commits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Commits authored that week"}},"required":["weekStart","commits"],"additionalProperties":false},"description":"Commits per week on the default branch over the last 52 weeks, oldest first"},"contributors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The author's name"},"email":{"type":"string","description":"The author's email address"},"commits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Their commits in the last 52 weeks"}},"required":["name","email","commits"],"additionalProperties":false},"description":"Who committed to the default branch in the last 52 weeks, most commits first (at most 200)"},"commitsInYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Commits on the default branch in the last 52 weeks"},"pullRequests":{"type":"object","properties":{"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests opened in the last 30 days"},"merged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests merged in the last 30 days"},"closed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests closed unmerged in the last 30 days"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests open (or draft) now"}},"required":["opened","merged","closed","open"],"additionalProperties":false,"description":"Pull request activity"}},"required":["weeks","contributors","commitsInYear","pullRequests"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/issues":{"get":{"operationId":"git.issues.list","summary":"List a repository’s issues, newest first","description":"`git:ListIssues` List a repository’s issues, newest first. Each with its labels, assignee IAM user ids and comment count. Issues and pull requests share one numbering per repository.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The issue id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number, shared with pull requests in one sequence per repository"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed"],"description":"Whether it is open or closed"},"stateReason":{"anyOf":[{"type":"string","enum":["completed","not_planned"]},{"type":"null"}],"description":"Why it was closed (done, or not going to be done); null while open"},"authorIamUserId":{"description":"The IAM user who opened it; null once that user is deleted","type":["string","null"]},"closedAt":{"description":"When it was closed (ISO 8601); null while open","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed or was commented on (ISO 8601)"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"name":{"type":"string","description":"The label name"},"color":{"type":"string","description":"Six hex digits, without #"}},"required":["id","name","color"],"additionalProperties":false},"description":"The labels it carries"},"assigneeIamUserIds":{"type":"array","items":{"type":"string"},"description":"The IAM users it is assigned to"},"comments":{"type":"number","description":"How many comments it has"}},"required":["id","orgId","repoId","number","title","body","state","stateReason","authorIamUserId","closedAt","createdAt","updatedAt","labels","assigneeIamUserIds","comments"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListIssues","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.issues.create","summary":"Open an issue","description":"`git:CreateIssue` Open an issue.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":256,"description":"The title"},"body":{"description":"The description (Markdown)","type":"string","maxLength":65536},"labels":{"description":"Label names; each must exist in the repository","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"assigneeIamUserIds":{"description":"IAM users of the organization to assign","maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["title"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The issue id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number, shared with pull requests in one sequence per repository"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed"],"description":"Whether it is open or closed"},"stateReason":{"anyOf":[{"type":"string","enum":["completed","not_planned"]},{"type":"null"}],"description":"Why it was closed (done, or not going to be done); null while open"},"authorIamUserId":{"description":"The IAM user who opened it; null once that user is deleted","type":["string","null"]},"closedAt":{"description":"When it was closed (ISO 8601); null while open","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed or was commented on (ISO 8601)"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"name":{"type":"string","description":"The label name"},"color":{"type":"string","description":"Six hex digits, without #"}},"required":["id","name","color"],"additionalProperties":false},"description":"The labels it carries"},"assigneeIamUserIds":{"type":"array","items":{"type":"string"},"description":"The IAM users it is assigned to"}},"required":["id","orgId","repoId","number","title","body","state","stateReason","authorIamUserId","closedAt","createdAt","updatedAt","labels","assigneeIamUserIds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/issues/{number}":{"get":{"operationId":"git.issues.get","summary":"One issue with its comments","description":"`git:ListIssues` One issue with its comments.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"number","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The issue id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number, shared with pull requests in one sequence per repository"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed"],"description":"Whether it is open or closed"},"stateReason":{"anyOf":[{"type":"string","enum":["completed","not_planned"]},{"type":"null"}],"description":"Why it was closed (done, or not going to be done); null while open"},"authorIamUserId":{"description":"The IAM user who opened it; null once that user is deleted","type":["string","null"]},"closedAt":{"description":"When it was closed (ISO 8601); null while open","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed or was commented on (ISO 8601)"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"name":{"type":"string","description":"The label name"},"color":{"type":"string","description":"Six hex digits, without #"}},"required":["id","name","color"],"additionalProperties":false},"description":"The labels it carries"},"assigneeIamUserIds":{"type":"array","items":{"type":"string"},"description":"The IAM users it is assigned to"},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The comment id"},"orgId":{"type":"string","description":"The organization it belongs to"},"issueId":{"type":"string","description":"The issue it is on"},"authorIamUserId":{"description":"The IAM user who wrote it; null once that user is deleted","type":["string","null"]},"body":{"type":"string","description":"The comment (Markdown)"},"createdAt":{"type":"string","description":"When it was written (ISO 8601)"}},"required":["id","orgId","issueId","authorIamUserId","body","createdAt"],"additionalProperties":false},"description":"Its comments, oldest first"}},"required":["id","orgId","repoId","number","title","body","state","stateReason","authorIamUserId","closedAt","createdAt","updatedAt","labels","assigneeIamUserIds","comments"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListIssues","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"git.issues.update","summary":"Edit, close or reopen an issue; replace its labels or assignees","description":"`git:UpdateIssue` Edit, close or reopen an issue; replace its labels or assignees.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"number","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"description":"The new title","type":"string","minLength":1,"maxLength":256},"body":{"description":"The new description (Markdown); null clears it","anyOf":[{"type":"string","maxLength":65536},{"type":"null"}]},"state":{"description":"`closed` closes the issue, `open` reopens it","type":"string","enum":["open","closed"]},"stateReason":{"description":"Why it is closed; completed when absent","type":"string","enum":["completed","not_planned"]},"labels":{"description":"Replaces the labels; each name must exist in the repository","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},"assigneeIamUserIds":{"description":"Replaces the assignees: IAM users of the organization","maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The issue id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number, shared with pull requests in one sequence per repository"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed"],"description":"Whether it is open or closed"},"stateReason":{"anyOf":[{"type":"string","enum":["completed","not_planned"]},{"type":"null"}],"description":"Why it was closed (done, or not going to be done); null while open"},"authorIamUserId":{"description":"The IAM user who opened it; null once that user is deleted","type":["string","null"]},"closedAt":{"description":"When it was closed (ISO 8601); null while open","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed or was commented on (ISO 8601)"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"name":{"type":"string","description":"The label name"},"color":{"type":"string","description":"Six hex digits, without #"}},"required":["id","name","color"],"additionalProperties":false},"description":"The labels it carries"},"assigneeIamUserIds":{"type":"array","items":{"type":"string"},"description":"The IAM users it is assigned to"}},"required":["id","orgId","repoId","number","title","body","state","stateReason","authorIamUserId","closedAt","createdAt","updatedAt","labels","assigneeIamUserIds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/issues/{number}/comments":{"post":{"operationId":"git.issues.comment","summary":"Comment on an issue","description":"`git:CommentOnIssue` Comment on an issue.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"number","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":65536,"description":"The comment (Markdown)"}},"required":["body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The comment id"},"orgId":{"type":"string","description":"The organization it belongs to"},"issueId":{"type":"string","description":"The issue it is on"},"authorIamUserId":{"description":"The IAM user who wrote it; null once that user is deleted","type":["string","null"]},"body":{"type":"string","description":"The comment (Markdown)"},"createdAt":{"type":"string","description":"When it was written (ISO 8601)"}},"required":["id","orgId","issueId","authorIamUserId","body","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CommentOnIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/labels":{"get":{"operationId":"git.labels.list","summary":"List labels","description":"`git:ListIssues` List labels.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"name":{"type":"string","description":"The label name, unique within the repository"},"color":{"type":"string","description":"Six hex digits, without #"},"description":{"description":"What the label means; null when none was given","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"}},"required":["id","orgId","repoId","name","color","description","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListIssues","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.labels.create","summary":"Create a label","description":"`git:ManageLabels` Create a label.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"The label name, unique in the repository"},"color":{"description":"Six hex digits, e.g. d73a4a; grey (6b7280) when absent","type":"string"},"description":{"description":"What the label is for","type":"string","maxLength":200}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"name":{"type":"string","description":"The label name, unique within the repository"},"color":{"type":"string","description":"Six hex digits, without #"},"description":{"description":"What the label means; null when none was given","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"}},"required":["id","orgId","repoId","name","color","description","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageLabels","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/labels/{labelId}":{"patch":{"operationId":"git.labels.update","summary":"Rename, recolour or describe a label","description":"`git:ManageLabels` Rename, recolour or describe a label.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name","type":"string","minLength":1,"maxLength":50},"color":{"description":"The new colour: six hex digits, e.g. d73a4a","type":"string"},"description":{"description":"The new description; null removes it","anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"name":{"type":"string","description":"The label name, unique within the repository"},"color":{"type":"string","description":"Six hex digits, without #"},"description":{"description":"What the label means; null when none was given","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"}},"required":["id","orgId","repoId","name","color","description","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageLabels","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.labels.delete","summary":"Delete a label (it comes off every issue and pull request)","description":"`git:ManageLabels` Delete a label (it comes off every issue and pull request).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deleted":{"type":"boolean","const":true,"description":"Always true: the label is gone"}},"required":["deleted"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageLabels","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/merge-queue":{"get":{"operationId":"git.merge-queue.get","summary":"Show a branch queue: settings, entries in order, recent results and events","description":"`git:GetMergeQueue` Show a branch queue: settings, entries in order, recent results and events.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"branch","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255,"description":"The target branch whose queue to show"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"branch":{"type":"string","description":"The branch whose queue this is"},"required":{"type":"boolean","description":"A protection rule requires a merge queue on it"},"config":{"anyOf":[{"type":"object","properties":{"ruleId":{"type":"string","description":"The branch protection rule that requires the queue"},"method":{"type":"string","enum":["merge","squash","rebase"],"description":"How queued pull requests are merged"},"buildConcurrency":{"type":"number","description":"Builds that may run at once"},"minGroupSize":{"type":"number","description":"Fewest pull requests merged together"},"maxGroupSize":{"type":"number","description":"Most pull requests merged together"},"waitMinutes":{"type":"number","description":"Minutes to wait for the minimum group to fill"},"checkTimeoutMinutes":{"type":"number","description":"Minutes a build may take before it counts as failed"},"onlyNonFailing":{"type":"boolean","description":"A failed build removes its pull request at once, rather than waiting on later builds"}},"required":["ruleId","method","buildConcurrency","minGroupSize","maxGroupSize","waitMinutes","checkTimeoutMinutes","onlyNonFailing"],"additionalProperties":false},{"type":"null"}],"description":"The queue settings; null when none"},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The queue entry id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository"},"prId":{"type":"string","description":"The pull request queued"},"baseBranch":{"type":"string","description":"The protected branch the queue merges into"},"state":{"type":"string","enum":["waiting","queued","building","passed","failed","merged","removed"],"description":"waiting (for approvals and checks), queued, building, passed, failed, merged or removed"},"position":{"description":"1-based place in line; null while waiting","type":["number","null"]},"headOid":{"description":"Pull request head when it joined the line; null while waiting","type":["string","null"]},"baseOid":{"description":"The commit its build sits on; null until built","type":["string","null"]},"groupOid":{"description":"The commit built: the base, every entry ahead, and this one; null until built","type":["string","null"]},"tempRef":{"description":"The temporary branch built; null until built","type":["string","null"]},"mergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"How it will be merged"},"enqueuedByIamUserId":{"description":"Who added it; null when that IAM user is gone","type":["string","null"]},"removalReason":{"description":"Why it left the queue; null unless removed","type":["string","null"]},"queuedAt":{"description":"When it joined the line; null while waiting","type":["string","null"]},"buildStartedAt":{"description":"When its build started; null until then","type":["string","null"]},"finishedAt":{"description":"When it merged or left; null while in the queue","type":["string","null"]},"createdAt":{"type":"string","description":"When it was added"},"updatedAt":{"type":"string","description":"When it last changed"},"pr":{"type":"object","properties":{"number":{"type":"number","description":"The pull request number"},"title":{"type":"string","description":"Its title"},"sourceBranch":{"type":"string","description":"Its source branch"},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"Its state"},"authorIamUserId":{"type":"string","description":"Who opened it"},"sourceOid":{"description":"Its head commit, as last recorded","type":["string","null"]}},"required":["number","title","sourceBranch","state","authorIamUserId","sourceOid"],"additionalProperties":false,"description":"The pull request of the entry"}},"required":["id","orgId","repoId","prId","baseBranch","state","position","headOid","baseOid","groupOid","tempRef","mergeMethod","enqueuedByIamUserId","removalReason","queuedAt","buildStartedAt","finishedAt","createdAt","updatedAt","pr"],"additionalProperties":false},"description":"The entries still in the queue, in order"},"finished":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The queue entry id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository"},"prId":{"type":"string","description":"The pull request queued"},"baseBranch":{"type":"string","description":"The protected branch the queue merges into"},"state":{"type":"string","enum":["waiting","queued","building","passed","failed","merged","removed"],"description":"waiting (for approvals and checks), queued, building, passed, failed, merged or removed"},"position":{"type":"number","description":"Sort key in the queue: a larger one is further back"},"headOid":{"description":"Pull request head when it joined the line; null while waiting","type":["string","null"]},"baseOid":{"description":"The commit its build sits on; null until built","type":["string","null"]},"groupOid":{"description":"The commit built: the base, every entry ahead, and this one; null until built","type":["string","null"]},"tempRef":{"description":"The temporary branch built; null until built","type":["string","null"]},"mergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"How it will be merged"},"enqueuedByIamUserId":{"description":"Who added it; null when that IAM user is gone","type":["string","null"]},"removalReason":{"description":"Why it left the queue; null unless removed","type":["string","null"]},"queuedAt":{"description":"When it joined the line; null while waiting","type":["string","null"]},"buildStartedAt":{"description":"When its build started; null until then","type":["string","null"]},"finishedAt":{"description":"When it merged or left; null while in the queue","type":["string","null"]},"createdAt":{"type":"string","description":"When it was added"},"updatedAt":{"type":"string","description":"When it last changed"},"pr":{"type":"object","properties":{"number":{"type":"number","description":"The pull request number"},"title":{"type":"string","description":"Its title"},"sourceBranch":{"type":"string","description":"Its source branch"},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"Its state"},"authorIamUserId":{"type":"string","description":"Who opened it"},"sourceOid":{"description":"Its head commit, as last recorded","type":["string","null"]}},"required":["number","title","sourceBranch","state","authorIamUserId","sourceOid"],"additionalProperties":false,"description":"The pull request of the entry"}},"required":["id","orgId","repoId","prId","baseBranch","state","position","headOid","baseOid","groupOid","tempRef","mergeMethod","enqueuedByIamUserId","removalReason","queuedAt","buildStartedAt","finishedAt","createdAt","updatedAt","pr"],"additionalProperties":false},"description":"The last 20 entries that merged or left, newest first"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The event id"},"orgId":{"type":"string","description":"The organization"},"repoId":{"type":"string","description":"The repository"},"baseBranch":{"type":"string","description":"The queue, by its branch"},"entryId":{"description":"The queue entry concerned; null for the queue as a whole","type":["string","null"]},"prId":{"description":"The pull request concerned; null for the queue as a whole","type":["string","null"]},"kind":{"type":"string","enum":["waiting","queued","build_started","checks_passed","checks_failed","conflict","rebuild","merged","removed"],"description":"What happened"},"detail":{"description":"A sentence on what happened and why","type":["string","null"]},"actorIamUserId":{"description":"Who acted; null when the queue itself did","type":["string","null"]},"commitOid":{"description":"The commit concerned, if any","type":["string","null"]},"createdAt":{"type":"string","description":"When it happened"},"prNumber":{"description":"The pull request number; null when none","type":["number","null"]},"actor":{"description":"The actor's username; null when the queue acted","type":["string","null"]}},"required":["id","orgId","repoId","baseBranch","entryId","prId","kind","detail","actorIamUserId","commitOid","createdAt","prNumber","actor"],"additionalProperties":false},"description":"The last 100 queue events, newest first"}},"required":["branch","required","config","entries","finished","events"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetMergeQueue","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/mirror":{"get":{"operationId":"git.repositories.get-mirror-status","summary":"A mirror's last day (syncs, failures, lag), recent syncs and failures","description":"`git:GetRepository` A mirror's last day (syncs, failures, lag), recent syncs and failures.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"mirror":{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},"last24h":{"type":"object","properties":{"syncs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Syncs that fetched in the last 24 hours"},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, failed"},"refsChanged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Refs they changed in all"},"lagP50Seconds":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Median lag in seconds; null when no branch moved"},"lagP95Seconds":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"95th percentile lag in seconds; null when no branch moved"}},"required":["syncs","failed","refsChanged","lagP50Seconds","lagP95Seconds"],"additionalProperties":false,"description":"The last day in numbers"},"syncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The sync id"},"orgId":{"type":"string","description":"The organization"},"repoId":{"type":"string","description":"The mirror repository"},"trigger":{"type":"string","enum":["poll","interval","manual"],"description":"What started it: the minute poll saw a change, the interval, or a person"},"outcome":{"type":"string","enum":["succeeded","failed"],"description":"How it ended"},"error":{"description":"Why it failed; null when it succeeded","type":["string","null"]},"changes":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","description":"The full ref name, e.g. refs/heads/main"},"oldOid":{"description":"The commit it pointed at before; null if new","type":["string","null"]},"newOid":{"description":"The commit it points at now; null if deleted","type":["string","null"]}},"required":["ref","oldOid","newOid"],"additionalProperties":false},"description":"Refs that moved, appeared or went (at most 200)"},"changedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many refs changed"},"lagSeconds":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Seconds from the newest moved branch tip's commit to its arrival here, at most; null when no branch moved"},"startedAt":{"type":"string","description":"When it started (ISO 8601)"},"finishedAt":{"type":"string","description":"When it finished (ISO 8601)"}},"required":["id","orgId","repoId","trigger","outcome","error","changes","changedCount","lagSeconds","startedAt","finishedAt"],"additionalProperties":false},"description":"The last 50 syncs, newest first"},"failures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The sync id"},"orgId":{"type":"string","description":"The organization"},"repoId":{"type":"string","description":"The mirror repository"},"trigger":{"type":"string","enum":["poll","interval","manual"],"description":"What started it: the minute poll saw a change, the interval, or a person"},"outcome":{"type":"string","enum":["succeeded","failed"],"description":"How it ended"},"error":{"description":"Why it failed; null when it succeeded","type":["string","null"]},"changes":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","description":"The full ref name, e.g. refs/heads/main"},"oldOid":{"description":"The commit it pointed at before; null if new","type":["string","null"]},"newOid":{"description":"The commit it points at now; null if deleted","type":["string","null"]}},"required":["ref","oldOid","newOid"],"additionalProperties":false},"description":"Refs that moved, appeared or went (at most 200)"},"changedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many refs changed"},"lagSeconds":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Seconds from the newest moved branch tip's commit to its arrival here, at most; null when no branch moved"},"startedAt":{"type":"string","description":"When it started (ISO 8601)"},"finishedAt":{"type":"string","description":"When it finished (ISO 8601)"}},"required":["id","orgId","repoId","trigger","outcome","error","changes","changedCount","lagSeconds","startedAt","finishedAt"],"additionalProperties":false},"description":"The last 20 failed syncs, newest first"}},"required":["mirror","last24h","syncs","failures"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"git.repositories.update-mirror","summary":"Change a mirror's interval, the minute poll, or shadow CI","description":"`git:UpdateRepository` Change a mirror's interval, the minute poll, or shadow CI.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intervalMinutes":{"description":"Minutes between full fetches","type":"integer","minimum":5,"maximum":1440},"continuous":{"description":"Check the source every minute (git ls-remote) and fetch when a ref moved","type":"boolean"},"shadowCi":{"description":"Run the source workflows here on mirrored pushes to compare: no secrets, no deploy or publish jobs","type":"object","properties":{"enabled":{"type":"boolean"},"branches":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"description":"Branch patterns (main, release/*); the default branch when empty"}},"required":["enabled","branches"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.repositories.stop-mirror","summary":"Stop mirroring: syncing ends and pushes become possible; history, branches, tags and pull requests stay","description":"`git:StopMirroring` Stop mirroring: syncing ends and pushes become possible; history, branches, tags and pull requests stay.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:StopMirroring","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/mirror/shadow-run":{"post":{"operationId":"git.repositories.run-shadow-ci","summary":"Run a shadowed mirror's workflows on a branch's current head now (default: the default branch)","description":"`ci:StartWorkflow` Run a shadowed mirror's workflows on a branch's current head now (default: the default branch).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branch":{"description":"Default: the default branch","type":"string","minLength":1,"maxLength":255}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"commitOid":{"type":"string","description":"The head commit the shadow runs were started on"}},"required":["commitOid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:StartWorkflow","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/mirror/sync":{"post":{"operationId":"git.repositories.sync-mirror","summary":"Fetch a mirror from its source now","description":"`git:UpdateRepository` Fetch a mirror from its source now.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls":{"get":{"operationId":"git.pulls.list","summary":"List pull requests","description":"`git:ListPullRequests` List pull requests.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"state","in":"query","required":false,"schema":{"description":"Only pull requests in this state; every state when absent","type":"string","enum":["open","closed","merged","draft"]}},{"name":"author","in":"query","required":false,"schema":{"description":"Opened by this IAM username, or for an imported pull request this login on the source; `@me` for the caller","type":"string","minLength":1,"maxLength":200}},{"name":"assignee","in":"query","required":false,"schema":{"description":"Assigned to this IAM username; `@me` for the caller","type":"string","minLength":1,"maxLength":200}},{"name":"reviewer","in":"query","required":false,"schema":{"description":"Review requested from, or given by, this IAM username; `@me` for the caller","type":"string","minLength":1,"maxLength":200}},{"name":"label","in":"query","required":false,"schema":{"description":"Carries this label; `@me` for the caller","type":"string","minLength":1,"maxLength":200}},{"name":"mentions","in":"query","required":false,"schema":{"description":"Only pull requests whose description or comments mention the caller","type":"string","const":"@me"}},{"name":"sort","in":"query","required":false,"schema":{"description":"Default: by number, newest first; `comments` puts the most commented first","type":"string","enum":["newest","oldest","updated","comments"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListPullRequests","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.pulls.create","summary":"Open a pull request","description":"`git:CreatePullRequest` Open a pull request.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200,"description":"The title"},"body":{"description":"The description (Markdown)","type":"string","maxLength":20000},"sourceBranch":{"type":"string","minLength":1,"maxLength":255,"description":"The branch with the changes"},"targetBranch":{"type":"string","minLength":1,"maxLength":255,"description":"The branch to merge them into"},"isDraft":{"description":"Open it as a draft, which cannot be merged until marked ready; false when absent","type":"boolean"}},"required":["title","sourceBranch","targetBranch"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreatePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}":{"get":{"operationId":"git.pulls.get","summary":"Show a pull request with mergeability, checks and approvals","description":"`git:GetPullRequest` Show a pull request with mergeability, checks and approvals. The diff is included only for a caller who also holds git:PullRepository; `canReadSource` in the response says which happened.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"},"conflicts":{"type":"array","items":{"type":"string"},"description":"The paths that conflict, recomputed now; empty when it merges cleanly"},"diff":{"anyOf":[{"type":"object","properties":{"patch":{"type":"string","description":"The unified diff of what the pull request proposes"},"filesChanged":{"type":"number","description":"Files changed"},"insertions":{"type":"number","description":"Lines added"},"deletions":{"type":"number","description":"Lines removed"},"truncated":{"type":"boolean","description":"True when the patch holds only the first files because the whole is too large"}},"required":["patch","filesChanged","insertions","deletions","truncated"],"additionalProperties":false},{"type":"null"}],"description":"The changes; null without git:PullRepository or when a branch is gone"},"canReadSource":{"type":"boolean","description":"False when the diff was withheld for lack of git:PullRepository"},"checks":{"anyOf":[{"type":"object","properties":{"passed":{"type":"boolean","description":"Status checks allow the merge"},"required":{"type":"boolean","description":"A protection rule on the target requires checks"},"pending":{"type":"boolean","description":"Checks are still running and may yet pass"},"checks":{"type":"array","items":{"type":"object","properties":{"workflowName":{"type":"string","description":"The workflow, job or commit status context checked"},"runId":{"type":"string","description":"The CI run; `status:<id>` for a reported commit status, empty while none has run"},"runNumber":{"type":"number","description":"The run number; 0 for a commit status or a check with no run yet"},"status":{"type":"string","enum":["queued","provisioning","running","succeeded","failed","cancelled","timed_out"],"description":"Where the check stands"},"required":{"description":"Whether the check gates the merge","type":"boolean"},"version":{"description":"Whether the run used the workflow file of the target branch (protected) or the pull request's (proposed)","type":"string","enum":["protected","proposed"]},"commitStatus":{"description":"Present when the check is a commit status an external tool reported","type":"object","properties":{"context":{"type":"string","description":"The context the external tool reported"},"description":{"description":"Its short summary; null when none was given","type":["string","null"]},"targetUrl":{"description":"Link to the details; null when none was given","type":["string","null"]}},"required":["context","description","targetUrl"],"additionalProperties":false}},"required":["workflowName","runId","runNumber","status"],"additionalProperties":false},"description":"Each check on the head commit"},"reason":{"description":"Why the checks block the merge; absent when they pass","type":"string"}},"required":["passed","required","pending","checks"],"additionalProperties":false},{"type":"null"}],"description":"Status checks on the head commit; null when the source branch is gone"},"approvals":{"type":"object","properties":{"passed":{"type":"boolean","description":"Approvals allow the merge"},"required":{"type":"number","description":"Approvals the target branch requires; 0 when none"},"counted":{"type":"number","description":"Approvals that count toward the requirement"},"dismissed":{"type":"number","description":"Approvals not counted because the branch moved after them"},"reason":{"description":"Why approvals block the merge; absent when they pass","type":"string"}},"required":["passed","required","counted","dismissed"],"additionalProperties":false,"description":"Where the required approvals stand"},"codeOwners":{"type":"object","properties":{"required":{"type":"boolean","description":"The target branch requires code owner review"},"passed":{"type":"boolean","description":"Code owner review allows the merge"},"missing":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"A changed file"},"owners":{"type":"array","items":{"type":"string"},"description":"Its owners, as CODEOWNERS names them"}},"required":["path","owners"],"additionalProperties":false},"description":"Changed files still waiting for an approval by an owner"},"reason":{"description":"Why code owners block the merge; absent when they pass","type":"string"}},"required":["required","passed","missing"],"additionalProperties":false,"description":"Where code owner review stands"},"mergeQueue":{"type":"object","properties":{"required":{"type":"boolean","description":"The target branch requires the merge queue"},"config":{"anyOf":[{"type":"object","properties":{"ruleId":{"type":"string","description":"The branch protection rule that requires the queue"},"method":{"type":"string","enum":["merge","squash","rebase"],"description":"How queued pull requests are merged"},"buildConcurrency":{"type":"number","description":"Builds that may run at once"},"minGroupSize":{"type":"number","description":"Fewest pull requests merged together"},"maxGroupSize":{"type":"number","description":"Most pull requests merged together"},"waitMinutes":{"type":"number","description":"Minutes to wait for the minimum group to fill"},"checkTimeoutMinutes":{"type":"number","description":"Minutes a build may take before it counts as failed"},"onlyNonFailing":{"type":"boolean","description":"A failed build removes its pull request at once, rather than waiting on later builds"}},"required":["ruleId","method","buildConcurrency","minGroupSize","maxGroupSize","waitMinutes","checkTimeoutMinutes","onlyNonFailing"],"additionalProperties":false},{"type":"null"}],"description":"The queue settings; null when no queue"},"entry":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The queue entry id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository"},"prId":{"type":"string","description":"The pull request queued"},"baseBranch":{"type":"string","description":"The protected branch the queue merges into"},"state":{"type":"string","enum":["waiting","queued","building","passed","failed","merged","removed"],"description":"waiting (for approvals and checks), queued, building, passed, failed, merged or removed"},"position":{"type":"number","description":"Sort key in the queue: a larger one is further back"},"headOid":{"description":"Pull request head when it joined the line; null while waiting","type":["string","null"]},"baseOid":{"description":"The commit its build sits on; null until built","type":["string","null"]},"groupOid":{"description":"The commit built: the base, every entry ahead, and this one; null until built","type":["string","null"]},"tempRef":{"description":"The temporary branch built; null until built","type":["string","null"]},"mergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"How it will be merged"},"enqueuedByIamUserId":{"description":"Who added it; null when that IAM user is gone","type":["string","null"]},"removalReason":{"description":"Why it left the queue; null unless removed","type":["string","null"]},"queuedAt":{"description":"When it joined the line; null while waiting","type":["string","null"]},"buildStartedAt":{"description":"When its build started; null until then","type":["string","null"]},"finishedAt":{"description":"When it merged or left; null while in the queue","type":["string","null"]},"createdAt":{"type":"string","description":"When it was added"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","prId","baseBranch","state","position","headOid","baseOid","groupOid","tempRef","mergeMethod","enqueuedByIamUserId","removalReason","queuedAt","buildStartedAt","finishedAt","createdAt","updatedAt"],"additionalProperties":false},{"type":"null"}],"description":"Its live queue entry, or how the last attempt ended; null when never queued"},"position":{"description":"1-based place in line; null while waiting or once finished","type":["number","null"]},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The event id"},"orgId":{"type":"string","description":"The organization"},"repoId":{"type":"string","description":"The repository"},"baseBranch":{"type":"string","description":"The queue, by its branch"},"entryId":{"description":"The queue entry concerned; null for the queue as a whole","type":["string","null"]},"prId":{"description":"The pull request concerned; null for the queue as a whole","type":["string","null"]},"kind":{"type":"string","enum":["waiting","queued","build_started","checks_passed","checks_failed","conflict","rebuild","merged","removed"],"description":"What happened"},"detail":{"description":"A sentence on what happened and why","type":["string","null"]},"actorIamUserId":{"description":"Who acted; null when the queue itself did","type":["string","null"]},"commitOid":{"description":"The commit concerned, if any","type":["string","null"]},"createdAt":{"type":"string","description":"When it happened"},"prNumber":{"description":"The pull request number; null when none","type":["number","null"]},"actor":{"description":"The actor's username; null when the queue acted","type":["string","null"]}},"required":["id","orgId","repoId","baseBranch","entryId","prId","kind","detail","actorIamUserId","commitOid","createdAt","prNumber","actor"],"additionalProperties":false},"description":"Its last 30 queue events, newest first"}},"required":["required","config","entry","position","events"],"additionalProperties":false,"description":"Where it stands in the merge queue of its target"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt","conflicts","diff","canReadSource","checks","approvals","codeOwners","mergeQueue"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetPullRequest","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-soft-action":"git:PullRepository"},"patch":{"operationId":"git.pulls.update","summary":"Edit a pull request's title or description","description":"`git:UpdatePullRequest` Edit a pull request's title or description. Only the fields sent change; `body: null` clears the description. Refused for a merged pull request and in an archived repository. Sends a `pull_request` webhook with `action: edited`.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"description":"The new title","type":"string","minLength":1,"maxLength":200},"body":{"description":"The new description (Markdown); null clears it","anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdatePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/assignees":{"put":{"operationId":"git.labels.set-pull-request-assignees","summary":"Replace a pull request’s assignees","description":"`git:UpdateIssue` Replace a pull request’s assignees. Members of the organization, as on an issue; each change is a timeline entry.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assigneeIamUserIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Replaces the assignees"}},"required":["assigneeIamUserIds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"assigneeIamUserIds":{"type":"array","items":{"type":"string"},"description":"The IAM users the pull request is assigned to now"}},"required":["assigneeIamUserIds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/auto-merge":{"put":{"operationId":"git.pulls.enable-auto-merge","summary":"Merge automatically once approvals and required checks pass","description":"`git:MergePullRequest` Merge automatically once approvals and required checks pass. Merges as the caller, with this method; merges at once if it already can (`result: merged`). Refused for a draft and on a branch that requires the merge queue. `autoMergeBlockedReason` on the pull request says what it waits for. Turned off if the caller later loses git:MergePullRequest.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["merge","squash","rebase"],"description":"merge records a merge commit, squash lands the branch as one commit, rebase replays each commit onto the target; the repository must allow it"}},"required":["method"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:MergePullRequest","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.pulls.disable-auto-merge","summary":"Turn auto-merge off","description":"`git:MergePullRequest` Turn auto-merge off.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:MergePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/close":{"post":{"operationId":"git.pulls.close","summary":"Close a pull request without merging","description":"`git:ClosePullRequest` Close a pull request without merging.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ClosePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/comments":{"get":{"operationId":"git.pulls.list-comments","summary":"List comments, including inline ones","description":"`git:GetPullRequest` List comments, including inline ones.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The comment id"},"prId":{"type":"string","description":"The pull request"},"orgId":{"type":"string","description":"The organization"},"authorIamUserId":{"type":"string","description":"Who wrote it"},"body":{"type":"string","description":"The comment (Markdown)"},"filePath":{"description":"For an inline comment, the file; null otherwise","type":["string","null"]},"line":{"description":"For an inline comment, the line; null otherwise","type":["number","null"]},"side":{"anyOf":[{"type":"string","enum":["old","new"]},{"type":"null"}],"description":"For an inline comment, the old or new side of the diff; null otherwise"},"commitOid":{"description":"For an inline comment, the head commit its line refers to","type":["string","null"]},"resolvedAt":{"description":"When the thread was resolved (on a thread's first comment); null when open","type":["string","null"]},"resolvedByIamUserId":{"description":"Who resolved the thread; null when open","type":["string","null"]},"replyToId":{"description":"The comment this replies to; null for a thread root","type":["string","null"]},"createdAt":{"type":"string","description":"When it was written"},"updatedAt":{"type":"string","description":"When it last changed"},"bodyHtml":{"description":"The comment rendered to HTML (sanitised, #n linked)","type":["string","null"]}},"required":["id","prId","orgId","authorIamUserId","body","filePath","line","side","commitOid","resolvedAt","resolvedByIamUserId","replyToId","createdAt","updatedAt","bodyHtml"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetPullRequest","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.pulls.comment","summary":"Comment on a pull request or on a line of it","description":"`git:ReviewPullRequest` Comment on a pull request or on a line of it.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":20000,"description":"The comment (Markdown)"},"replyToId":{"description":"The comment this one answers, in its thread","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filePath":{"description":"For a comment on a line: the changed file; give line and side with it","type":"string","minLength":1,"maxLength":1000},"line":{"description":"For a comment on a line: the line number in the file on `side`","type":"integer","minimum":1,"maximum":9007199254740991},"side":{"description":"For a comment on a line: `new` is the head version, `old` the version before","type":"string","enum":["old","new"]}},"required":["body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The comment id"},"prId":{"type":"string","description":"The pull request"},"orgId":{"type":"string","description":"The organization"},"authorIamUserId":{"type":"string","description":"Who wrote it"},"body":{"type":"string","description":"The comment (Markdown)"},"filePath":{"description":"For an inline comment, the file; null otherwise","type":["string","null"]},"line":{"description":"For an inline comment, the line; null otherwise","type":["number","null"]},"side":{"anyOf":[{"type":"string","enum":["old","new"]},{"type":"null"}],"description":"For an inline comment, the old or new side of the diff; null otherwise"},"commitOid":{"description":"For an inline comment, the head commit its line refers to","type":["string","null"]},"resolvedAt":{"description":"When the thread was resolved (on a thread's first comment); null when open","type":["string","null"]},"resolvedByIamUserId":{"description":"Who resolved the thread; null when open","type":["string","null"]},"replyToId":{"description":"The comment this replies to; null for a thread root","type":["string","null"]},"createdAt":{"type":"string","description":"When it was written"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","prId","orgId","authorIamUserId","body","filePath","line","side","commitOid","resolvedAt","resolvedByIamUserId","replyToId","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ReviewPullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/comments/{commentId}/apply-suggestion":{"post":{"operationId":"git.pulls.apply-suggestion","summary":"Commit a review comment's suggested change to the pull request's branch","description":"`git:PushRepository` Commit a review comment's suggested change to the pull request's branch. The comment must be on a line of the new side and carry a ```suggestion block; it replaces that line (empty deletes it). Refused once the branch has moved since the comment (409), and subject to branch protection like a push. Resolves the thread.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"commitOid":{"type":"string","description":"The new commit on the pull request's branch"}},"required":["commitOid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/comments/{commentId}/resolve":{"post":{"operationId":"git.pulls.resolve-comment","summary":"Mark a comment thread resolved or reopen it","description":"`git:ReviewPullRequest` Mark a comment thread resolved or reopen it. Only thread roots are resolvable; a reply returns 404.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolved":{"type":"boolean","description":"true resolves the thread, false reopens it"}},"required":["resolved"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The comment id"},"prId":{"type":"string","description":"The pull request"},"orgId":{"type":"string","description":"The organization"},"authorIamUserId":{"type":"string","description":"Who wrote it"},"body":{"type":"string","description":"The comment (Markdown)"},"filePath":{"description":"For an inline comment, the file; null otherwise","type":["string","null"]},"line":{"description":"For an inline comment, the line; null otherwise","type":["number","null"]},"side":{"anyOf":[{"type":"string","enum":["old","new"]},{"type":"null"}],"description":"For an inline comment, the old or new side of the diff; null otherwise"},"commitOid":{"description":"For an inline comment, the head commit its line refers to","type":["string","null"]},"resolvedAt":{"description":"When the thread was resolved (on a thread's first comment); null when open","type":["string","null"]},"resolvedByIamUserId":{"description":"Who resolved the thread; null when open","type":["string","null"]},"replyToId":{"description":"The comment this replies to; null for a thread root","type":["string","null"]},"createdAt":{"type":"string","description":"When it was written"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","prId","orgId","authorIamUserId","body","filePath","line","side","commitOid","resolvedAt","resolvedByIamUserId","replyToId","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ReviewPullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/draft":{"post":{"operationId":"git.pulls.convert-to-draft","summary":"Turn an open pull request back into a draft (fires converted_to_draft: webhooks and the workflows that list it)","description":"`git:UpdatePullRequest` Turn an open pull request back into a draft (fires converted_to_draft: webhooks and the workflows that list it).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdatePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/labels":{"put":{"operationId":"git.labels.set-pull-request-labels","summary":"Replace a pull request’s labels","description":"`git:UpdateIssue` Replace a pull request’s labels. Workflows see them as github.event.pull_request.labels (contains(github.event.pull_request.labels.*.name, …)).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":50},"description":"Label names replacing the current set (empty removes all); each must exist in the repository"}},"required":["labels"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The label id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository it belongs to"},"name":{"type":"string","description":"The label name, unique within the repository"},"color":{"type":"string","description":"Six hex digits, without #"},"description":{"description":"What the label means; null when none was given","type":["string","null"]},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"}},"required":["id","orgId","repoId","name","color","description","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateIssue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/merge":{"post":{"operationId":"git.pulls.merge","summary":"Merge, squash or rebase a pull request","description":"`git:MergePullRequest` Merge, squash or rebase a pull request.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"The commit message; when absent `Merge pull request #n from <branch>` and the title, or for a squash `Title (#n)` and the description. A rebase keeps each commit message","type":"string","maxLength":500},"method":{"default":"merge","type":"string","enum":["merge","squash","rebase"],"description":"merge records a merge commit, squash lands the branch as one commit, rebase replays each commit onto the target; the repository must allow it"},"expectedHeadSha":{"description":"Merge only if the source branch is still at this commit; otherwise 409","type":"string","pattern":"^[0-9a-f]{40}$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:MergePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/merge-queue":{"post":{"operationId":"git.merge-queue.add","summary":"Add a pull request to its target branch merge queue (\"merge when ready\")","description":"`git:AddToMergeQueue` Add a pull request to its target branch merge queue (\"merge when ready\"). Only for a target branch whose protection rule requires a merge queue. If approvals or checks are not yet satisfied the entry waits (state `waiting`) and joins the end of the line once they are. The queue builds `ews-readonly-queue/<base>/pr-<n>-<sha>` with every pull request ahead of it, runs `merge_group` CI on it, and fast-forwards the base when the checks pass.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The queue entry id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository"},"prId":{"type":"string","description":"The pull request queued"},"baseBranch":{"type":"string","description":"The protected branch the queue merges into"},"state":{"type":"string","enum":["waiting","queued","building","passed","failed","merged","removed"],"description":"waiting (for approvals and checks), queued, building, passed, failed, merged or removed"},"position":{"type":"number","description":"Sort key in the queue: a larger one is further back"},"headOid":{"description":"Pull request head when it joined the line; null while waiting","type":["string","null"]},"baseOid":{"description":"The commit its build sits on; null until built","type":["string","null"]},"groupOid":{"description":"The commit built: the base, every entry ahead, and this one; null until built","type":["string","null"]},"tempRef":{"description":"The temporary branch built; null until built","type":["string","null"]},"mergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"How it will be merged"},"enqueuedByIamUserId":{"description":"Who added it; null when that IAM user is gone","type":["string","null"]},"removalReason":{"description":"Why it left the queue; null unless removed","type":["string","null"]},"queuedAt":{"description":"When it joined the line; null while waiting","type":["string","null"]},"buildStartedAt":{"description":"When its build started; null until then","type":["string","null"]},"finishedAt":{"description":"When it merged or left; null while in the queue","type":["string","null"]},"createdAt":{"type":"string","description":"When it was added"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","prId","baseBranch","state","position","headOid","baseOid","groupOid","tempRef","mergeMethod","enqueuedByIamUserId","removalReason","queuedAt","buildStartedAt","finishedAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:AddToMergeQueue","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.merge-queue.remove","summary":"Remove a pull request from the merge queue","description":"`git:RemoveFromMergeQueue` Remove a pull request from the merge queue. Builds behind it are thrown away and rebuilt without it.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The queue entry id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository"},"prId":{"type":"string","description":"The pull request queued"},"baseBranch":{"type":"string","description":"The protected branch the queue merges into"},"state":{"type":"string","enum":["waiting","queued","building","passed","failed","merged","removed"],"description":"waiting (for approvals and checks), queued, building, passed, failed, merged or removed"},"position":{"type":"number","description":"Sort key in the queue: a larger one is further back"},"headOid":{"description":"Pull request head when it joined the line; null while waiting","type":["string","null"]},"baseOid":{"description":"The commit its build sits on; null until built","type":["string","null"]},"groupOid":{"description":"The commit built: the base, every entry ahead, and this one; null until built","type":["string","null"]},"tempRef":{"description":"The temporary branch built; null until built","type":["string","null"]},"mergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"How it will be merged"},"enqueuedByIamUserId":{"description":"Who added it; null when that IAM user is gone","type":["string","null"]},"removalReason":{"description":"Why it left the queue; null unless removed","type":["string","null"]},"queuedAt":{"description":"When it joined the line; null while waiting","type":["string","null"]},"buildStartedAt":{"description":"When its build started; null until then","type":["string","null"]},"finishedAt":{"description":"When it merged or left; null while in the queue","type":["string","null"]},"createdAt":{"type":"string","description":"When it was added"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","prId","baseBranch","state","position","headOid","baseOid","groupOid","tempRef","mergeMethod","enqueuedByIamUserId","removalReason","queuedAt","buildStartedAt","finishedAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:RemoveFromMergeQueue","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/ready":{"post":{"operationId":"git.pulls.ready","summary":"Mark a draft ready for review (fires ready_for_review: webhooks and the workflows that list it)","description":"`git:UpdatePullRequest` Mark a draft ready for review (fires ready_for_review: webhooks and the workflows that list it).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdatePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/reopen":{"post":{"operationId":"git.pulls.reopen","summary":"Reopen a closed pull request","description":"`git:ClosePullRequest` Reopen a closed pull request. Guarded by git:ClosePullRequest, not an action of its own — it is the same open/closed transition, and a policy that could close but not reopen would be a trap. A merged pull request cannot be reopened.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The pull request id"},"orgId":{"type":"string","description":"The organization that owns it"},"repoId":{"type":"string","description":"The repository it belongs to"},"number":{"type":"number","description":"Its number in the repository, as in #12"},"title":{"type":"string","description":"The title"},"body":{"description":"The description (Markdown); null when there is none","type":["string","null"]},"state":{"type":"string","enum":["open","closed","merged","draft"],"description":"open, draft, closed (without merging) or merged"},"sourceBranch":{"type":"string","description":"The branch with the changes"},"targetBranch":{"type":"string","description":"The branch it merges into"},"sourceOid":{"description":"Head commit of the source branch when mergeability was last computed","type":["string","null"]},"targetOid":{"description":"Tip of the target branch when mergeability was last computed","type":["string","null"]},"mergeStatus":{"type":"string","enum":["unknown","mergeable","conflicted","up_to_date"],"description":"Whether it merges cleanly: mergeable, conflicted, up_to_date (nothing to merge) or unknown"},"mergeConflicts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The conflicting paths when conflicted; null when not known"},"mergeCommitOid":{"description":"The commit the merge produced; null until merged","type":["string","null"]},"authorIamUserId":{"type":"string","description":"The IAM user who opened it (for an imported one, who ran the import)"},"isDraft":{"type":"boolean","description":"A draft, not yet ready for review"},"mergedAt":{"description":"When it was merged; null unless merged","type":["string","null"]},"closedAt":{"description":"When it was closed; null while open","type":["string","null"]},"externalAuthor":{"description":"For an imported pull request, who opened it at the source; null otherwise","type":["string","null"]},"externalUrl":{"description":"For an imported pull request, its address at the source; null otherwise","type":["string","null"]},"autoMergeMethod":{"anyOf":[{"type":"string","enum":["merge","squash","rebase"]},{"type":"null"}],"description":"The method auto-merge will use; null when auto-merge is off"},"autoMergeIamUserId":{"description":"Who turned auto-merge on, and as whom it merges; null when off","type":["string","null"]},"autoMergeEnabledAt":{"description":"When auto-merge was turned on; null when off","type":["string","null"]},"autoMergeBlockedReason":{"description":"Why the last auto-merge attempt did not merge; null when nothing blocks it","type":["string","null"]},"createdAt":{"type":"string","description":"When it was opened"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","orgId","repoId","number","title","body","state","sourceBranch","targetBranch","sourceOid","targetOid","mergeStatus","mergeConflicts","mergeCommitOid","authorIamUserId","isDraft","mergedAt","closedAt","externalAuthor","externalUrl","autoMergeMethod","autoMergeIamUserId","autoMergeEnabledAt","autoMergeBlockedReason","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ClosePullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/reviewers":{"get":{"operationId":"git.pulls.list-reviewers","summary":"List requested reviewers","description":"`git:GetPullRequest` List requested reviewers.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The review request id"},"reviewerIamUserId":{"type":"string","description":"Who is asked to review"},"requestedAt":{"type":"string","description":"When it was asked"},"username":{"type":"string","description":"The reviewer's username"},"displayName":{"description":"The reviewer's display name; null when unset","type":["string","null"]}},"required":["id","reviewerIamUserId","requestedAt","username","displayName"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetPullRequest","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.pulls.add-reviewer","summary":"Request a review from someone","description":"`git:ReviewPullRequest` Request a review from someone.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reviewerIamUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The IAM user of the organization asked to review"}},"required":["reviewerIamUserId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The review request id"},"reviewerIamUserId":{"type":"string","description":"Who is asked to review"},"requestedAt":{"type":"string","description":"When it was asked"},"username":{"type":"string","description":"The reviewer's username"},"displayName":{"description":"The reviewer's display name; null when unset","type":["string","null"]}},"required":["id","reviewerIamUserId","requestedAt","username","displayName"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ReviewPullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/reviewers/{reviewerId}":{"delete":{"operationId":"git.pulls.remove-reviewer","summary":"Withdraw a review request","description":"`git:ReviewPullRequest` Withdraw a review request.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"reviewerId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The review request id"},"reviewerIamUserId":{"type":"string","description":"Who is asked to review"},"requestedAt":{"type":"string","description":"When it was asked"},"username":{"type":"string","description":"The reviewer's username"},"displayName":{"description":"The reviewer's display name; null when unset","type":["string","null"]}},"required":["id","reviewerIamUserId","requestedAt","username","displayName"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ReviewPullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/reviews":{"get":{"operationId":"git.pulls.list-reviews","summary":"List reviews on a pull request","description":"`git:GetPullRequest` List reviews on a pull request.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The review id"},"prId":{"type":"string","description":"The pull request"},"orgId":{"type":"string","description":"The organization"},"reviewerIamUserId":{"type":"string","description":"Who reviewed"},"state":{"type":"string","enum":["pending","approved","changes_requested","commented"],"description":"The verdict"},"body":{"description":"The review text; null when none","type":["string","null"]},"reviewedOid":{"description":"The head commit reviewed; an approval on an older one may be dismissed","type":["string","null"]},"createdAt":{"type":"string","description":"When it was given"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","prId","orgId","reviewerIamUserId","state","body","reviewedOid","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetPullRequest","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.pulls.review","summary":"Approve, request changes, or comment","description":"`git:ReviewPullRequest` Approve, request changes, or comment.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["approved","changes_requested","commented"],"description":"Your verdict; an approval counts toward required approvals"},"body":{"description":"The review text (Markdown)","type":"string","maxLength":20000}},"required":["state"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The review id"},"prId":{"type":"string","description":"The pull request"},"orgId":{"type":"string","description":"The organization"},"reviewerIamUserId":{"type":"string","description":"Who reviewed"},"state":{"type":"string","enum":["pending","approved","changes_requested","commented"],"description":"The verdict"},"body":{"description":"The review text; null when none","type":["string","null"]},"reviewedOid":{"description":"The head commit reviewed; an approval on an older one may be dismissed","type":["string","null"]},"createdAt":{"type":"string","description":"When it was given"},"updatedAt":{"type":"string","description":"When it last changed"}},"required":["id","prId","orgId","reviewerIamUserId","state","body","reviewedOid","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ReviewPullRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/pulls/{prNumber}/viewed":{"get":{"operationId":"git.pulls.list-viewed-files","summary":"The files you marked viewed that have not changed since","description":"`git:GetPullRequest` The files you marked viewed that have not changed since. Per caller. A mark counts while the head still has the blob it was marked at, so a push that changes a file clears its mark and leaves the others.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"headOid":{"description":"The head commit the marks were checked against; null when there is none","type":["string","null"]},"paths":{"type":"array","items":{"type":"string"},"description":"Files you marked viewed that have not changed since"}},"required":["headOid","paths"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetPullRequest","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"git.pulls.mark-file-viewed","summary":"Mark one file viewed, or clear the mark, for yourself","description":"`git:MarkFilesViewed` Mark one file viewed, or clear the mark, for yourself.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"prNumber","in":"path","required":true,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":1000,"description":"A changed file's path at the head"},"viewed":{"type":"boolean","description":"true marks it viewed, false clears the mark"}},"required":["path","viewed"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"path":{"type":"string","description":"The file"},"viewed":{"type":"boolean","description":"Whether it is marked viewed now"}},"required":["path","viewed"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:MarkFilesViewed","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/push-mirror":{"put":{"operationId":"git.repositories.set-push-mirror","summary":"Copy every push to a remote outside Deutsche Cloud (branches and tags)","description":"`git:ConfigurePushMirror` Copy every push to a remote outside Deutsche Cloud (branches and tags). Fast-forward only and nothing is deleted on the remote: a branch that moved there on its own is listed in `pushMirror.rejectedRefs` with `lastStatus: failed` instead of being overwritten. Pushes once at once, then after every push, merge or console edit. The token is never returned.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":500,"description":"https URL of the remote repository, without credentials (https://github.com/acme/app.git)"},"token":{"type":"string","minLength":1,"maxLength":500,"description":"A token allowed to push there (GitHub: fine-grained, Contents: write); stored sealed, never shown"}},"required":["url","token"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConfigurePushMirror","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.repositories.remove-push-mirror","summary":"Stop copying pushes to the remote; it keeps what it has","description":"`git:ConfigurePushMirror` Stop copying pushes to the remote; it keeps what it has.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConfigurePushMirror","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/push-mirror/sync":{"post":{"operationId":"git.repositories.sync-push-mirror","summary":"Push to the push mirror now","description":"`git:ConfigurePushMirror` Push to the push mirror now.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ConfigurePushMirror","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/raw":{"get":{"operationId":"git.files.raw","summary":"Serve one file verbatim","description":"`git:PullRepository` Serve one file verbatim.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1000,"description":"The file's path from the repository root, e.g. src/index.ts"}},{"name":"download","in":"query","required":false,"schema":{"description":"`1` answers it as an attachment to save; otherwise it is served inline","type":"string","enum":["0","1"]}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PullRepository","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/releases":{"get":{"operationId":"git.releases.list","summary":"List a repository’s releases, newest first","description":"`git:ListReleases` List a repository’s releases, newest first.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The release id"},"tagName":{"type":"string","description":"The tag it publishes, without refs/tags/"},"commitOid":{"type":"string","description":"The commit the tag pointed at when the release was created"},"name":{"type":"string","description":"The title; the tag name unless one was given"},"body":{"type":"string","description":"Release notes (Markdown); empty when none were written"},"draft":{"type":"boolean","description":"A draft is not published yet"},"prerelease":{"type":"boolean","description":"Marked a pre-release"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"publishedAt":{"description":"When it was published (ISO 8601); null while it is a draft","type":["string","null"]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The asset id"},"name":{"type":"string","description":"The file name it downloads as; unique within the release"},"contentType":{"type":"string","description":"The content type declared at upload; downloads are always application/octet-stream"},"sizeBytes":{"type":"number","description":"Size of the file, in bytes"},"downloadCount":{"type":"number","description":"How many times it was downloaded"},"createdAt":{"type":"string","description":"When it was uploaded (ISO 8601)"},"downloadUrl":{"type":"string","description":"The API path that downloads the file"}},"required":["id","name","contentType","sizeBytes","downloadCount","createdAt","downloadUrl"],"additionalProperties":false},"description":"Files attached to the release"}},"required":["id","tagName","commitOid","name","body","draft","prerelease","createdAt","publishedAt","assets"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListReleases","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.releases.create","summary":"Create a release (and its tag, when new)","description":"`git:CreateRelease` Create a release (and its tag, when new). A new tag is created at `target` (default branch when absent) and needs git:PushRepository too. A non-draft release fires `release` with created, published and released (or prereleased); a draft only created. Answers the release and `runIds` of the workflows it started.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tagName":{"type":"string","minLength":1,"maxLength":255,"description":"The tag; created at `target` when it does not exist"},"target":{"description":"Branch or commit for a new tag; the default branch when absent","type":"string","minLength":1,"maxLength":255},"name":{"description":"Title; the tag name when absent","type":"string","maxLength":255},"body":{"description":"Release notes (Markdown)","type":"string","maxLength":125000},"draft":{"description":"A draft fires only `created`; publish it later","type":"boolean"},"prerelease":{"description":"Mark it a pre-release (fires `prereleased` instead of `released`); false when absent","type":"boolean"}},"required":["tagName"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The release id"},"tagName":{"type":"string","description":"The tag it publishes, without refs/tags/"},"commitOid":{"type":"string","description":"The commit the tag pointed at when the release was created"},"name":{"type":"string","description":"The title; the tag name unless one was given"},"body":{"type":"string","description":"Release notes (Markdown); empty when none were written"},"draft":{"type":"boolean","description":"A draft is not published yet"},"prerelease":{"type":"boolean","description":"Marked a pre-release"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"publishedAt":{"description":"When it was published (ISO 8601); null while it is a draft","type":["string","null"]},"runIds":{"type":"array","items":{"type":"string"},"description":"Workflow runs the `release` event started; empty when none did"}},"required":["id","tagName","commitOid","name","body","draft","prerelease","createdAt","publishedAt","runIds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateRelease","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/releases/{releaseId}":{"get":{"operationId":"git.releases.get","summary":"One release","description":"`git:ListReleases` One release.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The release id"},"tagName":{"type":"string","description":"The tag it publishes, without refs/tags/"},"commitOid":{"type":"string","description":"The commit the tag pointed at when the release was created"},"name":{"type":"string","description":"The title; the tag name unless one was given"},"body":{"type":"string","description":"Release notes (Markdown); empty when none were written"},"draft":{"type":"boolean","description":"A draft is not published yet"},"prerelease":{"type":"boolean","description":"Marked a pre-release"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"publishedAt":{"description":"When it was published (ISO 8601); null while it is a draft","type":["string","null"]}},"required":["id","tagName","commitOid","name","body","draft","prerelease","createdAt","publishedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListReleases","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"git.releases.update","summary":"Edit a release, or publish a draft (draft: false)","description":"`git:UpdateRelease` Edit a release, or publish a draft (draft: false).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"New title; an empty one resets it to the tag name","type":"string","maxLength":255},"body":{"description":"New release notes (Markdown), replacing the old","type":"string","maxLength":125000},"draft":{"description":"false publishes a draft (fires published + released/prereleased)","type":"boolean","const":false},"prerelease":{"description":"Mark it a pre-release, or not","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The release id"},"tagName":{"type":"string","description":"The tag it publishes, without refs/tags/"},"commitOid":{"type":"string","description":"The commit the tag pointed at when the release was created"},"name":{"type":"string","description":"The title; the tag name unless one was given"},"body":{"type":"string","description":"Release notes (Markdown); empty when none were written"},"draft":{"type":"boolean","description":"A draft is not published yet"},"prerelease":{"type":"boolean","description":"Marked a pre-release"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"publishedAt":{"description":"When it was published (ISO 8601); null while it is a draft","type":["string","null"]},"runIds":{"type":"array","items":{"type":"string"},"description":"Workflow runs the `release` event started; empty when none did"}},"required":["id","tagName","commitOid","name","body","draft","prerelease","createdAt","publishedAt","runIds"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRelease","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.releases.delete","summary":"Delete a release; its tag stays","description":"`git:DeleteRelease` Delete a release; its tag stays. Its assets are deleted with it, files included.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteRelease","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/releases/{releaseId}/assets":{"get":{"operationId":"git.release-assets.list","summary":"List a release's assets","description":"`git:ListReleases` List a release's assets.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The asset id"},"name":{"type":"string","description":"The file name it downloads as; unique within the release"},"contentType":{"type":"string","description":"The content type declared at upload; downloads are always application/octet-stream"},"sizeBytes":{"type":"number","description":"Size of the file, in bytes"},"downloadCount":{"type":"number","description":"How many times it was downloaded"},"createdAt":{"type":"string","description":"When it was uploaded (ISO 8601)"},"downloadUrl":{"type":"string","description":"The API path that downloads the file"}},"required":["id","name","contentType","sizeBytes","downloadCount","createdAt","downloadUrl"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListReleases","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/releases/{releaseId}/assets/{assetId}":{"delete":{"operationId":"git.release-assets.delete","summary":"Remove an asset and its file","description":"`git:UpdateRelease` Remove an asset and its file.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRelease","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/releases/{releaseId}/assets/{assetId}/download":{"get":{"operationId":"git.release-assets.download","summary":"Download an asset","description":"`git:ListReleases` Download an asset. Always application/octet-stream as an attachment; access is re-checked on every download. Counts toward downloadCount.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListReleases","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security":{"get":{"operationId":"git.security.get","summary":"The repository’s security overview: settings, policy, open alert counts","description":"`git:ListSecurityAlerts` The repository’s security overview: settings, policy, open alert counts. `policy` is the first of .github/SECURITY.md, SECURITY.md, docs/SECURITY.md on the default branch (null without git:PullRepository). `dependencyScan` is the last lockfile scan.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"settings":{"type":"object","properties":{"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"The default branch's lockfiles are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"}},"required":["secretPushProtection","dependencyAlerts","maxFileSizeMb"],"additionalProperties":false,"description":"The security settings of the repository"},"policy":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Where the policy file is, e.g. SECURITY.md"},"markdown":{"type":"string","description":"Its text (Markdown), at most 200,000 characters"}},"required":["path","markdown"],"additionalProperties":false},{"type":"null"}],"description":"The security policy on the default branch; null without one or without git:PullRepository"},"counts":{"type":"object","properties":{"secretsBypassed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Secrets pushed past protection and not yet resolved"},"secretsBlocked30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pushes refused for a secret in the last 30 days"},"dependencyCritical":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of critical severity"},"dependencyHigh":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of high severity"},"dependencyOther":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of medium, low or unknown severity"},"codeScanOpen":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open code scanning alerts on the default branch"}},"required":["secretsBypassed","secretsBlocked30d","dependencyCritical","dependencyHigh","dependencyOther","codeScanOpen"],"additionalProperties":false,"description":"Open alert counts"},"dependencyScan":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["running","succeeded","failed"],"description":"Where the scan is"},"commitOid":{"description":"The default-branch commit it scanned","type":["string","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"summary":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},{"type":"null"}],"description":"Counts the scan reported, by name; null while running"},"startedAt":{"type":"string","description":"When it started (ISO 8601)"},"finishedAt":{"description":"When it finished (ISO 8601); null while running","type":["string","null"]}},"required":["status","commitOid","error","summary","startedAt","finishedAt"],"additionalProperties":false},{"type":"null"}],"description":"The last lockfile scan; null if none ran yet"}},"required":["settings","policy","counts","dependencyScan"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-soft-action":"git:PullRepository"}},"/git/api/repositories/{repoId}/security/code-scanning-alerts":{"get":{"operationId":"git.security.list-code-scanning-alerts","summary":"Code scanning alerts on the default branch","description":"`git:ListSecurityAlerts` Code scanning alerts on the default branch.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"tool":{"type":"string","description":"The tool that reported it, e.g. Semgrep"},"fingerprint":{"type":"string","description":"Identifies the same finding across uploads"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once an analysis of the default branch no longer reports it"},"ruleId":{"type":"string","description":"The tool's rule id"},"ruleDescription":{"description":"The rule's description; null when the tool gives none","type":["string","null"]},"severity":{"type":"string","enum":["critical","high","medium","low","note"],"description":"The severity"},"message":{"type":"string","description":"What the tool says about this finding"},"path":{"type":"string","description":"The file, from the repository root"},"startLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"First line of the finding; null when not given"},"endLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Last line of the finding; null when not given"},"helpUri":{"description":"A link to the rule's documentation; null when none","type":["string","null"]},"firstSeenCommitOid":{"type":"string","description":"The commit it was first reported on"},"lastSeenCommitOid":{"type":"string","description":"The commit it was last reported on"},"lastSeenRef":{"type":"string","description":"The ref of the analysis that last saw it: the default branch or a pull request head"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When it was found fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first reported (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","tool","fingerprint","state","ruleId","ruleDescription","severity","message","path","startLine","endLine","helpUri","firstSeenCommitOid","lastSeenCommitOid","lastSeenRef","dismissedReason","dismissedByIamUserId","fixedAt","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/code-scanning-alerts/{alertId}":{"patch":{"operationId":"git.security.set-code-scanning-alert","summary":"Dismiss a code scanning alert with a reason, or reopen it","description":"`git:UpdateSecurityAlert` Dismiss a code scanning alert with a reason, or reopen it.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["open","dismissed"],"description":"`dismissed` closes the alert, `open` reopens it"},"reason":{"description":"Why it is dismissed","type":"string","maxLength":2000}},"required":["state"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"tool":{"type":"string","description":"The tool that reported it, e.g. Semgrep"},"fingerprint":{"type":"string","description":"Identifies the same finding across uploads"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once an analysis of the default branch no longer reports it"},"ruleId":{"type":"string","description":"The tool's rule id"},"ruleDescription":{"description":"The rule's description; null when the tool gives none","type":["string","null"]},"severity":{"type":"string","enum":["critical","high","medium","low","note"],"description":"The severity"},"message":{"type":"string","description":"What the tool says about this finding"},"path":{"type":"string","description":"The file, from the repository root"},"startLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"First line of the finding; null when not given"},"endLine":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Last line of the finding; null when not given"},"helpUri":{"description":"A link to the rule's documentation; null when none","type":["string","null"]},"firstSeenCommitOid":{"type":"string","description":"The commit it was first reported on"},"lastSeenCommitOid":{"type":"string","description":"The commit it was last reported on"},"lastSeenRef":{"type":"string","description":"The ref of the analysis that last saw it: the default branch or a pull request head"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When it was found fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first reported (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","tool","fingerprint","state","ruleId","ruleDescription","severity","message","path","startLine","endLine","helpUri","firstSeenCommitOid","lastSeenCommitOid","lastSeenRef","dismissedReason","dismissedByIamUserId","fixedAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateSecurityAlert","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/dependency-alerts":{"get":{"operationId":"git.security.list-dependency-alerts","summary":"Vulnerable dependencies in the default branch’s lockfiles","description":"`git:ListSecurityAlerts` Vulnerable dependencies in the default branch’s lockfiles.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once a scan no longer finds the vulnerable version"},"manifestPath":{"type":"string","description":"The lockfile the package is installed by"},"ecosystem":{"type":"string","description":"The package ecosystem, e.g. npm"},"packageName":{"type":"string","description":"The vulnerable package"},"installedVersion":{"type":"string","description":"The version the lockfile installs"},"fixedVersion":{"description":"The first version with the fix; null if none yet","type":["string","null"]},"vulnerabilityId":{"type":"string","description":"The advisory id, e.g. GHSA-… or CVE-…"},"severity":{"type":"string","enum":["critical","high","medium","low","unknown"],"description":"The severity"},"title":{"type":"string","description":"The advisory's title"},"url":{"description":"A link to the advisory; null when it has none","type":["string","null"]},"cvssScore":{"description":"CVSS base score, 0 to 10; null when not published","type":["number","null"]},"cvssVector":{"description":"CVSS vector string; null when not published","type":["string","null"]},"references":{"type":"array","items":{"type":"string"},"description":"Links the advisory cites"},"aliases":{"type":"array","items":{"type":"string"},"description":"Other ids of the same advisory"},"publishedAt":{"description":"When the advisory was published (ISO 8601); null when unknown","type":["string","null"]},"relationship":{"anyOf":[{"type":"string","enum":["direct","indirect"]},{"type":"null"}],"description":"direct: named in the manifest; indirect: pulled in by another package; null when unknown"},"chain":{"type":"array","items":{"type":"string"},"description":"From a direct dependency down to this package, name@version each"},"dev":{"description":"Only a development dependency; null when unknown","type":["boolean","null"]},"lastSeenCommitOid":{"type":"string","description":"The default-branch commit of the scan that last saw it"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedComment":{"description":"Own words beside the reason; null unless given","type":["string","null"]},"dismissedAt":{"description":"When it was dismissed (ISO 8601); null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When a scan found it fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first found (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","state","manifestPath","ecosystem","packageName","installedVersion","fixedVersion","vulnerabilityId","severity","title","url","cvssScore","cvssVector","references","aliases","publishedAt","relationship","chain","dev","lastSeenCommitOid","dismissedReason","dismissedComment","dismissedAt","dismissedByIamUserId","fixedAt","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/dependency-alerts/{alertId}":{"patch":{"operationId":"git.security.set-dependency-alert","summary":"Dismiss a dependency alert with a reason, or reopen it","description":"`git:UpdateSecurityAlert` Dismiss a dependency alert with a reason, or reopen it.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["open","dismissed"],"description":"`dismissed` closes the alert, `open` reopens it"},"reason":{"description":"Why it is dismissed: false positive, not exploitable, accepted risk, fix later, or your own words","type":"string","maxLength":2000},"comment":{"description":"Your own words beside the reason","type":"string","maxLength":2000}},"required":["state"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once a scan no longer finds the vulnerable version"},"manifestPath":{"type":"string","description":"The lockfile the package is installed by"},"ecosystem":{"type":"string","description":"The package ecosystem, e.g. npm"},"packageName":{"type":"string","description":"The vulnerable package"},"installedVersion":{"type":"string","description":"The version the lockfile installs"},"fixedVersion":{"description":"The first version with the fix; null if none yet","type":["string","null"]},"vulnerabilityId":{"type":"string","description":"The advisory id, e.g. GHSA-… or CVE-…"},"severity":{"type":"string","enum":["critical","high","medium","low","unknown"],"description":"The severity"},"title":{"type":"string","description":"The advisory's title"},"url":{"description":"A link to the advisory; null when it has none","type":["string","null"]},"cvssScore":{"description":"CVSS base score, 0 to 10; null when not published","type":["number","null"]},"cvssVector":{"description":"CVSS vector string; null when not published","type":["string","null"]},"references":{"type":"array","items":{"type":"string"},"description":"Links the advisory cites"},"aliases":{"type":"array","items":{"type":"string"},"description":"Other ids of the same advisory"},"publishedAt":{"description":"When the advisory was published (ISO 8601); null when unknown","type":["string","null"]},"relationship":{"anyOf":[{"type":"string","enum":["direct","indirect"]},{"type":"null"}],"description":"direct: named in the manifest; indirect: pulled in by another package; null when unknown"},"chain":{"type":"array","items":{"type":"string"},"description":"From a direct dependency down to this package, name@version each"},"dev":{"description":"Only a development dependency; null when unknown","type":["boolean","null"]},"lastSeenCommitOid":{"type":"string","description":"The default-branch commit of the scan that last saw it"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedComment":{"description":"Own words beside the reason; null unless given","type":["string","null"]},"dismissedAt":{"description":"When it was dismissed (ISO 8601); null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When a scan found it fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first found (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"},"description":{"description":"The advisory as published (Markdown); null for alerts found before it was kept","type":["string","null"]}},"required":["id","orgId","repoId","state","manifestPath","ecosystem","packageName","installedVersion","fixedVersion","vulnerabilityId","severity","title","url","cvssScore","cvssVector","references","aliases","publishedAt","relationship","chain","dev","lastSeenCommitOid","dismissedReason","dismissedComment","dismissedAt","dismissedByIamUserId","fixedAt","createdAt","updatedAt","description"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateSecurityAlert","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"git.security.get-dependency-alert","summary":"One dependency alert: the advisory in full, CVSS, links, why the package is installed, and every place it is","description":"`git:ListSecurityAlerts` One dependency alert: the advisory in full, CVSS, links, why the package is installed, and every place it is.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once a scan no longer finds the vulnerable version"},"manifestPath":{"type":"string","description":"The lockfile the package is installed by"},"ecosystem":{"type":"string","description":"The package ecosystem, e.g. npm"},"packageName":{"type":"string","description":"The vulnerable package"},"installedVersion":{"type":"string","description":"The version the lockfile installs"},"fixedVersion":{"description":"The first version with the fix; null if none yet","type":["string","null"]},"vulnerabilityId":{"type":"string","description":"The advisory id, e.g. GHSA-… or CVE-…"},"severity":{"type":"string","enum":["critical","high","medium","low","unknown"],"description":"The severity"},"title":{"type":"string","description":"The advisory's title"},"url":{"description":"A link to the advisory; null when it has none","type":["string","null"]},"cvssScore":{"description":"CVSS base score, 0 to 10; null when not published","type":["number","null"]},"cvssVector":{"description":"CVSS vector string; null when not published","type":["string","null"]},"references":{"type":"array","items":{"type":"string"},"description":"Links the advisory cites"},"aliases":{"type":"array","items":{"type":"string"},"description":"Other ids of the same advisory"},"publishedAt":{"description":"When the advisory was published (ISO 8601); null when unknown","type":["string","null"]},"relationship":{"anyOf":[{"type":"string","enum":["direct","indirect"]},{"type":"null"}],"description":"direct: named in the manifest; indirect: pulled in by another package; null when unknown"},"chain":{"type":"array","items":{"type":"string"},"description":"From a direct dependency down to this package, name@version each"},"dev":{"description":"Only a development dependency; null when unknown","type":["boolean","null"]},"lastSeenCommitOid":{"type":"string","description":"The default-branch commit of the scan that last saw it"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedComment":{"description":"Own words beside the reason; null unless given","type":["string","null"]},"dismissedAt":{"description":"When it was dismissed (ISO 8601); null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When a scan found it fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first found (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"},"description":{"description":"The advisory as published (Markdown); null for alerts found before it was kept","type":["string","null"]}},"required":["id","orgId","repoId","state","manifestPath","ecosystem","packageName","installedVersion","fixedVersion","vulnerabilityId","severity","title","url","cvssScore","cvssVector","references","aliases","publishedAt","relationship","chain","dev","lastSeenCommitOid","dismissedReason","dismissedComment","dismissedAt","dismissedByIamUserId","fixedAt","createdAt","updatedAt","description"],"additionalProperties":false,"description":"The alert, with the advisory in full"},"places":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["open","fixed","dismissed"],"description":"fixed once a scan no longer finds the vulnerable version"},"manifestPath":{"type":"string","description":"The lockfile the package is installed by"},"ecosystem":{"type":"string","description":"The package ecosystem, e.g. npm"},"packageName":{"type":"string","description":"The vulnerable package"},"installedVersion":{"type":"string","description":"The version the lockfile installs"},"fixedVersion":{"description":"The first version with the fix; null if none yet","type":["string","null"]},"vulnerabilityId":{"type":"string","description":"The advisory id, e.g. GHSA-… or CVE-…"},"severity":{"type":"string","enum":["critical","high","medium","low","unknown"],"description":"The severity"},"title":{"type":"string","description":"The advisory's title"},"url":{"description":"A link to the advisory; null when it has none","type":["string","null"]},"cvssScore":{"description":"CVSS base score, 0 to 10; null when not published","type":["number","null"]},"cvssVector":{"description":"CVSS vector string; null when not published","type":["string","null"]},"references":{"type":"array","items":{"type":"string"},"description":"Links the advisory cites"},"aliases":{"type":"array","items":{"type":"string"},"description":"Other ids of the same advisory"},"publishedAt":{"description":"When the advisory was published (ISO 8601); null when unknown","type":["string","null"]},"relationship":{"anyOf":[{"type":"string","enum":["direct","indirect"]},{"type":"null"}],"description":"direct: named in the manifest; indirect: pulled in by another package; null when unknown"},"chain":{"type":"array","items":{"type":"string"},"description":"From a direct dependency down to this package, name@version each"},"dev":{"description":"Only a development dependency; null when unknown","type":["boolean","null"]},"lastSeenCommitOid":{"type":"string","description":"The default-branch commit of the scan that last saw it"},"dismissedReason":{"description":"Why it was dismissed; null unless dismissed","type":["string","null"]},"dismissedComment":{"description":"Own words beside the reason; null unless given","type":["string","null"]},"dismissedAt":{"description":"When it was dismissed (ISO 8601); null unless dismissed","type":["string","null"]},"dismissedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who dismissed it; null unless dismissed"},"fixedAt":{"description":"When a scan found it fixed (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When it was first found (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","state","manifestPath","ecosystem","packageName","installedVersion","fixedVersion","vulnerabilityId","severity","title","url","cvssScore","cvssVector","references","aliases","publishedAt","relationship","chain","dev","lastSeenCommitOid","dismissedReason","dismissedComment","dismissedAt","dismissedByIamUserId","fixedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Every lockfile entry of the same package and advisory, this one included, by lockfile"}},"required":["alert","places"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/dependency-alerts/fix":{"post":{"operationId":"git.security.fix-dependencies","summary":"Fix the security issues of this repository: open a pull request that bumps the vulnerable dependencies of its package-lock.json and pnpm-lock.yaml","description":"`git:CreatePullRequest` Fix the security issues of this repository: open a pull request that bumps the vulnerable dependencies of its package-lock.json and pnpm-lock.yaml. Answers 202; the platform creates a branch, bumps the versions, updates the lockfile with the package manager (no install scripts, public registry) and opens a pull request listing the advisories, so CI runs. It never merges. Needs git:PushRepository too. `get-dependency-fix` shows the outcome; 409 names an open fix pull request for the same package.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"packages":{"description":"Package groups to fix, as `ecosystem:package` (e.g. `pnpm:vite`); leave out to fix every package a fixed version exists for","minItems":1,"maxItems":500,"type":"array","items":{"type":"string","minLength":3,"maxLength":300}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"queued":{"type":"boolean","description":"Always true: the fix was queued"}},"required":["queued"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreatePullRequest","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"git.security.get-dependency-fix","summary":"The last fix pull request asked for, and the open ones","description":"`git:ListSecurityAlerts` The last fix pull request asked for, and the open ones.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"last":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["running","succeeded","failed"],"description":"Where the fix is"},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"prNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The pull request it opened; null while running or when it failed"},"startedAt":{"type":"string","description":"When it was asked for (ISO 8601)"},"finishedAt":{"description":"When it finished (ISO 8601); null while running","type":["string","null"]}},"required":["status","error","prNumber","startedAt","finishedAt"],"additionalProperties":false},{"type":"null"}],"description":"The last fix asked for; null if none was"},"openPullRequests":{"type":"array","items":{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The pull request number"},"title":{"type":"string","description":"Its title"},"sourceBranch":{"type":"string","description":"Its branch, under ews/deps/"}},"required":["number","title","sourceBranch"],"additionalProperties":false},"description":"Fix pull requests still open"}},"required":["last","openPullRequests"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/dependency-alerts/scan":{"post":{"operationId":"git.security.scan-dependencies","summary":"Scan the default branch’s lockfiles now","description":"`git:UpdateSecurityAlert` Scan the default branch’s lockfiles now. Answers 202; the scan runs in the background and `get` shows its result.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"queued":{"type":"boolean","description":"Whether a new scan was queued; false when one is already waiting"}},"required":["queued"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateSecurityAlert","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/secret-alerts":{"get":{"operationId":"git.security.list-secret-alerts","summary":"Secrets push protection found: blocked, bypassed and resolved, plus scan gaps","description":"`git:ListSecurityAlerts` Secrets push protection found: blocked, bypassed and resolved, plus scan gaps. Never the secret itself: a redacted preview and a fingerprint. `gaps` lists pushes the scan could not finish (fail-open past its time or size budget).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["blocked","bypassed","resolved"],"description":"blocked: the push was refused; bypassed: pushed anyway and in the history; resolved: someone said what was done"},"ruleId":{"type":"string","description":"The detector that matched"},"ruleName":{"type":"string","description":"The kind of credential, in words"},"path":{"type":"string","description":"The file the secret is in"},"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The line it is on, from 1"},"blobOid":{"type":"string","description":"The id of the file content it was found in"},"refName":{"type":"string","description":"The ref that was pushed"},"commitOid":{"type":"string","description":"The pushed tip of the ref; the secret is in its history"},"fingerprint":{"type":"string","description":"A sha256 fingerprint to recognise the same secret again"},"preview":{"type":"string","description":"A redacted preview; never the secret itself"},"pushedBy":{"type":"string","description":"Who pushed: user:<IAM user id>, deploy:<deploy key id> or unknown"},"pushedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The IAM user who pushed; null for a deploy key or a deleted user"},"bypassReason":{"description":"Why it was pushed anyway; null unless bypassed","type":["string","null"]},"resolution":{"anyOf":[{"type":"string","enum":["revoked","false_positive","used_in_tests","wont_fix"]},{"type":"null"}],"description":"What was done about it; null until resolved"},"resolutionComment":{"description":"A note on the resolution, if any","type":["string","null"]},"resolvedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who resolved it; null until resolved"},"resolvedAt":{"description":"When it was resolved (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When the push was scanned (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","state","ruleId","ruleName","path","line","blobOid","refName","commitOid","fingerprint","preview","pushedBy","pushedByIamUserId","bypassReason","resolution","resolutionComment","resolvedByIamUserId","resolvedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"The newest 500 alerts, newest first"},"gaps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The gap"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"refName":{"type":"string","description":"The ref that was pushed"},"commitOid":{"type":"string","description":"The pushed tip of the ref"},"reason":{"type":"string","description":"Why the scan stopped short (time or size budget)"},"blobsScanned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Files the scan checked"},"blobsSkipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Files the scan did not get to"},"createdAt":{"type":"string","description":"When the push was scanned (ISO 8601)"}},"required":["id","orgId","repoId","refName","commitOid","reason","blobsScanned","blobsSkipped","createdAt"],"additionalProperties":false},"description":"The newest 50 pushes the scan could not finish"}},"required":["alerts","gaps"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/secret-alerts/{alertId}":{"patch":{"operationId":"git.security.resolve-secret-alert","summary":"Say what was done about a bypassed secret (revoked, false positive, …)","description":"`git:UpdateSecurityAlert` Say what was done about a bypassed secret (revoked, false positive, …).","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolution":{"type":"string","enum":["revoked","false_positive","used_in_tests","wont_fix"],"description":"What was done about the secret that was pushed"},"comment":{"description":"A note on the resolution, in your own words","type":"string","maxLength":2000}},"required":["resolution"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The alert"},"orgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization"},"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"state":{"type":"string","enum":["blocked","bypassed","resolved"],"description":"blocked: the push was refused; bypassed: pushed anyway and in the history; resolved: someone said what was done"},"ruleId":{"type":"string","description":"The detector that matched"},"ruleName":{"type":"string","description":"The kind of credential, in words"},"path":{"type":"string","description":"The file the secret is in"},"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The line it is on, from 1"},"blobOid":{"type":"string","description":"The id of the file content it was found in"},"refName":{"type":"string","description":"The ref that was pushed"},"commitOid":{"type":"string","description":"The pushed tip of the ref; the secret is in its history"},"fingerprint":{"type":"string","description":"A sha256 fingerprint to recognise the same secret again"},"preview":{"type":"string","description":"A redacted preview; never the secret itself"},"pushedBy":{"type":"string","description":"Who pushed: user:<IAM user id>, deploy:<deploy key id> or unknown"},"pushedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The IAM user who pushed; null for a deploy key or a deleted user"},"bypassReason":{"description":"Why it was pushed anyway; null unless bypassed","type":["string","null"]},"resolution":{"anyOf":[{"type":"string","enum":["revoked","false_positive","used_in_tests","wont_fix"]},{"type":"null"}],"description":"What was done about it; null until resolved"},"resolutionComment":{"description":"A note on the resolution, if any","type":["string","null"]},"resolvedByIamUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who resolved it; null until resolved"},"resolvedAt":{"description":"When it was resolved (ISO 8601); null until then","type":["string","null"]},"createdAt":{"type":"string","description":"When the push was scanned (ISO 8601)"},"updatedAt":{"type":"string","description":"When the alert last changed (ISO 8601)"}},"required":["id","orgId","repoId","state","ruleId","ruleName","path","line","blobOid","refName","commitOid","fingerprint","preview","pushedBy","pushedByIamUserId","bypassReason","resolution","resolutionComment","resolvedByIamUserId","resolvedAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateSecurityAlert","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/security/settings":{"patch":{"operationId":"git.security.update-settings","summary":"Turn secret push protection or dependency alerts on or off, set the file size limit","description":"`git:UpdateRepository` Turn secret push protection or dependency alerts on or off, set the file size limit.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"secretPushProtection":{"description":"Refuse pushes that add a known credential format (on by default)","type":"boolean"},"dependencyAlerts":{"description":"Check lockfiles on the default branch against the vulnerability database","type":"boolean"},"maxFileSizeMb":{"description":"Largest file a push may add, in MB; null for the platform default of 100","anyOf":[{"type":"integer","minimum":1,"maximum":2048},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"The default branch's lockfiles are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"}},"required":["secretPushProtection","dependencyAlerts","maxFileSizeMb"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/shadow-comparisons":{"get":{"operationId":"git.repositories.list-shadow-comparisons","summary":"A shadowed mirror's newest commits: the source's CI and ours side by side, in counts","description":"`ci:ListRuns` A shadowed mirror's newest commits: the source's CI and ours side by side, in counts.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"commitOid":{"type":"string","description":"The commit compared"},"ref":{"type":"string","description":"The ref it was pushed to"},"commitMessage":{"description":"Its message; null when unknown","type":["string","null"]},"queuedAt":{"type":"string","description":"When our shadow runs were queued (ISO 8601)"},"source":{"type":"object","properties":{"state":{"type":"string","enum":["none","running","done"],"description":"The source's results: not fetched yet, still running, or done"},"error":{"description":"Why they could not be read; null when they could","type":["string","null"]},"fetchedAt":{"description":"When they were last fetched (ISO 8601); null before","type":["string","null"]}},"required":["state","error","fetchedAt"],"additionalProperties":false,"description":"The state of the source's CI results"},"summary":{"type":"object","properties":{"jobs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs compared"},"same":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs with the same outcome on both sides"},"different":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs with different outcomes"},"onlyGithub":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs only the source ran"},"onlyHere":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs only we ran"},"notRunHere":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs we did not run (shadow runs skip some)"},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs not finished on one side yet"},"durationRatio":{"description":"Median of our duration over the source's, over jobs both finished; null when none","type":["number","null"]}},"required":["jobs","same","different","onlyGithub","onlyHere","notRunHere","pending","durationRatio"],"additionalProperties":false,"description":"The comparison in counts"}},"required":["commitOid","ref","commitMessage","queuedAt","source","summary"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListRuns","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/shadow-comparisons/{sha}":{"get":{"operationId":"git.repositories.get-shadow-comparison","summary":"One commit: every workflow and job, the source's result and ours, and the verdict","description":"`ci:ListRuns` One commit: every workflow and job, the source's result and ours, and the verdict.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sha","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{40}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"commitOid":{"type":"string","description":"The commit compared"},"ref":{"type":"string","description":"The ref it was pushed to"},"commitMessage":{"description":"Its message; null when unknown","type":["string","null"]},"queuedAt":{"type":"string","description":"When our shadow runs were queued (ISO 8601)"},"source":{"type":"object","properties":{"state":{"type":"string","enum":["none","running","done"],"description":"The source's results: not fetched yet, still running, or done"},"error":{"description":"Why they could not be read; null when they could","type":["string","null"]},"fetchedAt":{"description":"When they were last fetched (ISO 8601); null before","type":["string","null"]}},"required":["state","error","fetchedAt"],"additionalProperties":false,"description":"The state of the source's CI results"},"comparison":{"type":"object","properties":{"workflows":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The workflow file's path"},"name":{"type":"string","description":"The workflow name"},"githubUrl":{"description":"A link to the source's run; null when there is none","type":["string","null"]},"jobs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The job name"},"github":{"anyOf":[{"type":"object","properties":{"outcome":{"type":"string","enum":["success","failure","cancelled","skipped","pending"],"description":"How the job ended"},"seconds":{"description":"How long it took, in seconds; null when unknown","type":["number","null"]},"url":{"description":"A link to it; null when none","type":["string","null"]}},"required":["outcome","seconds","url"],"additionalProperties":false},{"type":"null"}],"description":"The source's result; null when the source did not run it"},"ours":{"anyOf":[{"type":"object","properties":{"outcome":{"type":"string","enum":["success","failure","cancelled","skipped","pending"],"description":"How the job ended"},"seconds":{"description":"How long it took, in seconds; null when unknown","type":["number","null"]},"note":{"description":"Why it differs or did not run here; null when nothing to say","type":["string","null"]}},"required":["outcome","seconds","note"],"additionalProperties":false},{"type":"null"}],"description":"Our result; null when we did not run it"},"verdict":{"type":"string","enum":["same","different","only-github","only-here","not-run-here","pending"],"description":"How the two compare"}},"required":["name","github","ours","verdict"],"additionalProperties":false},"description":"Its jobs, both sides"}},"required":["path","name","githubUrl","jobs"],"additionalProperties":false},"description":"Every workflow, both sides"},"summary":{"type":"object","properties":{"jobs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs compared"},"same":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs with the same outcome on both sides"},"different":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs with different outcomes"},"onlyGithub":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs only the source ran"},"onlyHere":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs only we ran"},"notRunHere":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs we did not run (shadow runs skip some)"},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Jobs not finished on one side yet"},"durationRatio":{"description":"Median of our duration over the source's, over jobs both finished; null when none","type":["number","null"]}},"required":["jobs","same","different","onlyGithub","onlyHere","notRunHere","pending","durationRatio"],"additionalProperties":false,"description":"The comparison in counts"}},"required":["workflows","summary"],"additionalProperties":false,"description":"Workflow by workflow, and the counts"}},"required":["commitOid","ref","commitMessage","queuedAt","source","comparison"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"ci:ListRuns","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/sync-fork":{"post":{"operationId":"git.repositories.sync-fork","summary":"Fast-forward a fork's branch to its parent's","description":"`git:PushRepository` Fast-forward a fork's branch to its parent's. Only a fast-forward: a branch with commits of its own is refused (409), nothing is overwritten. Goes through branch protection, CI and webhooks like a push.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branch":{"description":"The branch to bring up to the parent's branch of the same name; the default branch when absent","type":"string","minLength":1,"maxLength":255}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"ok":{"type":"boolean","const":true,"description":"Always true in a successful answer"},"updated":{"type":"boolean","description":"The branch moved; false when it was already level with the parent"},"commitOid":{"type":"string","description":"The commit the branch is at now"}},"required":["ok","updated","commitOid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/tag-protection":{"get":{"operationId":"git.tag-protection.list","summary":"List protected tag patterns","description":"`git:GetRepository` List protected tag patterns.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The rule's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"pattern":{"type":"string","description":"The protected tag name or glob, e.g. v*"},"createdAt":{"type":"string","description":"When the rule was added (ISO 8601)"}},"required":["id","orgId","repoId","pattern","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.tag-protection.create","summary":"Protect a tag pattern","description":"`git:ManageBranchProtection` Protect a tag pattern.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pattern":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._/*+-]+$","description":"Tag name or glob, e.g. v* or release-*; matching tags need git:PushProtectedTag"}},"required":["pattern"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The rule's id"},"orgId":{"type":"string","description":"Your organization"},"repoId":{"type":"string","description":"The repository the record belongs to"},"pattern":{"type":"string","description":"The protected tag name or glob, e.g. v*"},"createdAt":{"type":"string","description":"When the rule was added (ISO 8601)"}},"required":["id","orgId","repoId","pattern","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageBranchProtection","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/tag-protection/{ruleId}":{"delete":{"operationId":"git.tag-protection.delete","summary":"Remove a tag protection rule","description":"`git:ManageBranchProtection` Remove a tag protection rule.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deleted":{"type":"boolean","const":true,"description":"Always true: the rule is gone"}},"required":["deleted"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ManageBranchProtection","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/tags":{"get":{"operationId":"git.tags.list","summary":"List tags","description":"`git:GetRepository` List tags.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The tag name, e.g. v1.2.0"},"oid":{"type":"string","description":"The object the tag points at: the commit, or the annotated tag"},"subject":{"type":"string","description":"The first line of the tagged commit's (or tag's) message"},"authorName":{"type":"string","description":"Who wrote the tagged commit (or made the annotated tag)"},"authoredAt":{"type":"string","description":"When it was authored (ISO 8601)"}},"required":["name","oid","subject","authorName","authoredAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/tags/{name}":{"delete":{"operationId":"git.tags.delete","summary":"Delete a tag","description":"`git:PushRepository` Delete a tag. The console side of `git push --delete origin <tag>`, so it needs what a push needs. The route matches this segment as `:name{.+}` so tag names containing slashes survive; the value is URL-encoded on the wire. The commit the tag named is not deleted.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"The ref that was deleted"}},"required":["name"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/tree":{"get":{"operationId":"git.files.tree","summary":"List entries under a path","description":"`git:GetRepository` List entries under a path. File names are metadata; file contents are not — see `blob`.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"ref","in":"query","required":false,"schema":{"description":"Branch, tag or commit id; the default branch when absent","type":"string","minLength":1,"maxLength":255}},{"name":"path","in":"query","required":false,"schema":{"description":"The directory to list, from the repository root; the root when absent","type":"string","maxLength":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","description":"The git file mode, e.g. 100644 for a file or 040000 for a directory"},"type":{"type":"string","enum":["blob","tree","commit"],"description":"blob for a file, tree for a directory, commit for a submodule"},"oid":{"type":"string","description":"The object id of the entry"},"size":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Size in bytes; null for a directory or a submodule"},"path":{"type":"string","description":"The path from the repository root"},"name":{"type":"string","description":"The last segment of the path"}},"required":["mode","type","oid","size","path","name"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:GetRepository","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/update-branch":{"post":{"operationId":"git.branches.update-from","summary":"Bring a branch up to date with its target","description":"`git:PushRepository` Bring a branch up to date with its target.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branch":{"type":"string","minLength":1,"maxLength":255,"description":"The branch to bring up to date; it gets a merge commit"},"target":{"type":"string","minLength":1,"maxLength":255,"description":"The branch merged into it, usually the pull request target"}},"required":["branch","target"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"commitOid":{"type":"string","description":"The new commit, now the tip of the branch"}},"required":["commitOid"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:PushRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/webhooks":{"get":{"operationId":"git.webhooks.list","summary":"List webhooks","description":"`git:ListWebhooks` List webhooks.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The webhook id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository whose events it receives"},"url":{"type":"string","description":"The URL each delivery is POSTed to"},"events":{"type":"string","description":"The events it subscribes to, as a JSON array in text, e.g. [\"push\",\"pull_request\"]"},"isActive":{"type":"boolean","description":"Whether events are delivered; an inactive hook receives none"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed (ISO 8601)"},"hasSecret":{"type":"boolean","description":"Whether deliveries are signed with a secret; the secret itself is never returned"}},"required":["id","orgId","repoId","url","events","isActive","createdAt","updatedAt","hasSecret"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListWebhooks","x-ews-mutates":false,"x-ews-sensitive":true},"post":{"operationId":"git.webhooks.create","summary":"Add a webhook","description":"`git:CreateWebhook` Add a webhook.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The public URL each delivery is POSTed to"},"events":{"minItems":1,"type":"array","items":{"type":"string","enum":["push","tag","pull_request","pull_request_review","issues","issue_comment","release","merge_queue"]},"description":"The events that trigger a delivery"},"secret":{"description":"Signs each delivery with an HMAC-SHA256 of its body (`sha256=…` header); unsigned when absent","type":"string","maxLength":200},"isActive":{"description":"false pauses deliveries without deleting the hook; true when created without it","type":"boolean"}},"required":["url","events"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The webhook id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository whose events it receives"},"url":{"type":"string","description":"The URL each delivery is POSTed to"},"events":{"type":"string","description":"The events it subscribes to, as a JSON array in text, e.g. [\"push\",\"pull_request\"]"},"isActive":{"type":"boolean","description":"Whether events are delivered; an inactive hook receives none"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed (ISO 8601)"},"hasSecret":{"type":"boolean","description":"Whether deliveries are signed with a secret; the secret itself is never returned"}},"required":["id","orgId","repoId","url","events","isActive","createdAt","updatedAt","hasSecret"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateWebhook","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/webhooks/{hookId}":{"patch":{"operationId":"git.webhooks.update","summary":"Change a webhook","description":"`git:UpdateWebhook` Change a webhook. Only the fields sent are written. The secret is write-only — omit it to keep the stored one, send null to stop signing deliveries.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hookId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The public URL each delivery is POSTed to"},"events":{"minItems":1,"type":"array","items":{"type":"string","enum":["push","tag","pull_request","pull_request_review","issues","issue_comment","release","merge_queue"]},"description":"The events that trigger a delivery"},"secret":{"description":"A new signing secret; absent keeps the stored one, null stops signing","anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"isActive":{"description":"false pauses deliveries without deleting the hook; true when created without it","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The webhook id"},"orgId":{"type":"string","description":"The organization it belongs to"},"repoId":{"type":"string","description":"The repository whose events it receives"},"url":{"type":"string","description":"The URL each delivery is POSTed to"},"events":{"type":"string","description":"The events it subscribes to, as a JSON array in text, e.g. [\"push\",\"pull_request\"]"},"isActive":{"type":"boolean","description":"Whether events are delivered; an inactive hook receives none"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When it last changed (ISO 8601)"},"hasSecret":{"type":"boolean","description":"Whether deliveries are signed with a secret; the secret itself is never returned"}},"required":["id","orgId","repoId","url","events","isActive","createdAt","updatedAt","hasSecret"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateWebhook","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"git.webhooks.delete","summary":"Remove a webhook","description":"`git:DeleteWebhook` Remove a webhook.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hookId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteWebhook","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/{repoId}/webhooks/{hookId}/deliveries":{"get":{"operationId":"git.webhook-deliveries.list","summary":"List recent deliveries","description":"`git:ListWebhooks` List recent deliveries. Newest first, without bodies: status (pending, retrying, delivered, failed), attempts, response code and duration.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hookId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The delivery id, also sent as the X-EWS-Delivery header"},"orgId":{"type":"string","description":"The organization it belongs to"},"webhookId":{"type":"string","description":"The webhook it was sent to"},"event":{"type":"string","description":"The event delivered, e.g. push"},"status":{"type":"string","enum":["pending","retrying","delivered","failed"],"description":"Where the delivery stands: queued, retrying after a failure, delivered, or given up"},"attempts":{"type":"number","description":"How many times it was sent"},"responseStatus":{"description":"The HTTP status of the last answer; null before one arrived","type":["number","null"]},"error":{"description":"Why the last attempt failed when there was no HTTP answer; null otherwise","type":["string","null"]},"durationMs":{"description":"How long the last attempt took, in milliseconds; null before one","type":["number","null"]},"redeliveryOf":{"description":"The delivery this one resends; null for an original delivery","type":["string","null"]},"createdAt":{"type":"string","description":"When it was queued (ISO 8601)"},"lastAttemptAt":{"description":"When it was last sent (ISO 8601); null before the first attempt","type":["string","null"]}},"required":["id","orgId","webhookId","event","status","attempts","responseStatus","error","durationMs","redeliveryOf","createdAt","lastAttemptAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListWebhooks","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/webhooks/{hookId}/deliveries/{deliveryId}":{"get":{"operationId":"git.webhook-deliveries.get","summary":"Show one delivery","description":"`git:ListWebhooks` Show one delivery. The request body sent and the first 4 KiB of the answer.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hookId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The delivery id, also sent as the X-EWS-Delivery header"},"orgId":{"type":"string","description":"The organization it belongs to"},"webhookId":{"type":"string","description":"The webhook it was sent to"},"event":{"type":"string","description":"The event delivered, e.g. push"},"status":{"type":"string","enum":["pending","retrying","delivered","failed"],"description":"Where the delivery stands: queued, retrying after a failure, delivered, or given up"},"attempts":{"type":"number","description":"How many times it was sent"},"responseStatus":{"description":"The HTTP status of the last answer; null before one arrived","type":["number","null"]},"error":{"description":"Why the last attempt failed when there was no HTTP answer; null otherwise","type":["string","null"]},"durationMs":{"description":"How long the last attempt took, in milliseconds; null before one","type":["number","null"]},"redeliveryOf":{"description":"The delivery this one resends; null for an original delivery","type":["string","null"]},"createdAt":{"type":"string","description":"When it was queued (ISO 8601)"},"lastAttemptAt":{"description":"When it was last sent (ISO 8601); null before the first attempt","type":["string","null"]},"requestBody":{"type":"string","description":"The JSON body as sent"},"responseBody":{"description":"The first 4 KiB of the endpoint's answer; null when there was none","type":["string","null"]}},"required":["id","orgId","webhookId","event","status","attempts","responseStatus","error","durationMs","redeliveryOf","createdAt","lastAttemptAt","requestBody","responseBody"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListWebhooks","x-ews-mutates":false,"x-ews-sensitive":true}},"/git/api/repositories/{repoId}/webhooks/{hookId}/deliveries/{deliveryId}/redeliver":{"post":{"operationId":"git.webhook-deliveries.redeliver","summary":"Send a delivery again","description":"`git:UpdateWebhook` Send a delivery again. Queues a new delivery with its own id and the same body, signed with the current secret. Refused while the hook is inactive.","tags":["Git"],"parameters":[{"name":"repoId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"hookId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the new delivery"}},"required":["id"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:UpdateWebhook","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/repositories/import":{"post":{"operationId":"git.repositories.import","summary":"Import a repository from GitHub, GitLab or a git URL, optionally as a mirror","description":"`git:CreateRepository` Import a repository from GitHub, GitLab or a git URL, optionally as a mirror. Answers 202 with the new repository; `importState.status` goes queued → running → succeeded/failed, with counts of branches, tags and pull requests. History, branches, tags, pull requests (as pull requests here, original author and link in the body) and the wiki (as `{name}.wiki`) come over; issues and releases are not carried over. The fetch runs on the server, so there is no 2 GiB push limit.","tags":["Git"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$","description":"Unique within the organization; part of the clone URL"},"description":{"description":"One line about the repository, shown in lists and the About column","type":"string","maxLength":500},"visibility":{"description":"Who can see it; private when absent. public also needs git:PublishRepository","type":"string","enum":["private","public"]},"source":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":500,"description":"https://github.com/{owner}/{repo}, a GitLab project URL, or any https git URL"},"provider":{"description":"Guessed from the host when absent","type":"string","enum":["github","gitlab","git"]}},"required":["url"],"description":"Where to import from: its URL and, optionally, the provider"},"token":{"description":"GitHub/GitLab token for a private source or a higher API limit; kept (sealed) only for a mirror","type":"string","minLength":1,"maxLength":500},"include":{"description":"What comes over besides the git history: pull requests and the wiki (both by default)","type":"object","properties":{"pullRequests":{"description":"Default true","type":"boolean"},"wiki":{"description":"Default true; becomes repository {name}.wiki","type":"boolean"},"pullRequestLimit":{"description":"At most this many pull requests, newest first (default 10000): open and the newest closed with the import, the older ones in the background","type":"integer","minimum":1,"maximum":100000}}},"mirror":{"description":"Keep following the source; pushes are refused while it mirrors","type":"object","properties":{"intervalMinutes":{"description":"Default 15","type":"integer","minimum":5,"maximum":1440},"continuous":{"description":"Also check the source every minute and fetch as soon as a ref moved","type":"boolean"}}},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","source"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The repository id"},"orgId":{"type":"string","description":"The organization it belongs to"},"name":{"type":"string","description":"Its name, unique in the organization and part of the clone URL"},"description":{"description":"One line about it; null when none","type":["string","null"]},"homepage":{"description":"The About link; null when none","type":["string","null"]},"topics":{"type":"array","items":{"type":"string"},"description":"Its topics"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"defaultBranch":{"type":"string","description":"The branch clones check out and pull requests target by default"},"isEmpty":{"type":"boolean","description":"Nothing has been pushed yet"},"isArchived":{"type":"boolean","description":"Read-only: pushes, merges and edits are refused"},"allowMergeCommit":{"type":"boolean","description":"Pull requests may merge with a merge commit"},"allowSquashMerge":{"type":"boolean","description":"Pull requests may be squash-merged"},"allowRebaseMerge":{"type":"boolean","description":"Pull requests may be rebase-merged"},"deleteBranchOnMerge":{"type":"boolean","description":"A merged pull request's source branch is deleted"},"sizeBytes":{"type":"number","description":"Stored size in bytes, what storage is billed on"},"refsVersion":{"type":"number","description":"A counter that grows each time a branch or tag moves"},"lastPushedAt":{"description":"When the last push landed (ISO 8601); null before the first","type":["string","null"]},"importState":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Where the import stands"},"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source as given, without credentials"},"include":{"type":"object","properties":{"pullRequests":{"type":"boolean","description":"Pull requests are brought over"},"wiki":{"type":"boolean","description":"The wiki is brought over as repository {name}.wiki"},"pullRequestLimit":{"description":"At most this many pull requests, newest first","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pullRequests","wiki"],"additionalProperties":false,"description":"What was asked for besides the git history"},"pulls":{"description":"The pull requests' progress; absent until the import reaches them","type":"object","properties":{"total":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Pull requests the source has, in all states; null when it does not say"},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests imported so far"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"At most this many are imported"},"backfill":{"type":"string","enum":["running","done","failed"],"description":"The background import of the older closed pull requests"},"nextClosedPage":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The page of the source's closed pull requests read next; null when done"},"error":{"description":"Why the background import failed; null if not","type":["string","null"]}},"required":["total","imported","limit","backfill","nextClosedPage","error"],"additionalProperties":false},"importerIamUserId":{"description":"The IAM user who started it; imported pull requests are written as them","type":["string","null"]},"startedAt":{"description":"When it started (ISO 8601); null while queued","type":["string","null"]},"finishedAt":{"description":"When it ended (ISO 8601); null until then","type":["string","null"]},"error":{"description":"Why it failed; null unless it did","type":["string","null"]},"imported":{"anyOf":[{"type":"object","properties":{"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches brought over"},"tags":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tags brought over"},"pullRequests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull requests brought over"},"wikiRepositoryId":{"description":"The wiki repository created; null without a wiki","type":["string","null"]},"notes":{"type":"array","items":{"type":"string"},"description":"Remarks on what could not be carried over as is"}},"required":["branches","tags","pullRequests","wikiRepositoryId","notes"],"additionalProperties":false},{"type":"null"}],"description":"What came over; null until the import finished"}},"required":["status","provider","sourceUrl","include","importerIamUserId","startedAt","finishedAt","error","imported"],"additionalProperties":false},{"type":"null"}],"description":"The import or fork copy that filled the repository; null for one created empty"},"mirror":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["github","gitlab","git"],"description":"Where it comes from: GitHub, GitLab, or any git URL"},"sourceUrl":{"type":"string","description":"The source followed, without credentials"},"intervalMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between full fetches"},"lastSyncedAt":{"description":"When the last sync finished (ISO 8601); null before the first","type":["string","null"]},"lastError":{"description":"Why the last sync failed; null when it did not","type":["string","null"]},"pullsUpdatedThrough":{"description":"Pull requests changed on the source up to this time (ISO 8601) are in","type":"string"},"pullsUpdatedAtCorrectedAt":{"description":"When the imported pull requests' update times were taken from the source","type":"string"},"mergeMethodsReadAt":{"description":"When the source's merge methods were last applied here (ISO 8601)","type":"string"},"continuous":{"description":"The source is checked every minute and fetched as soon as a ref moved","type":"boolean"},"shadowCi":{"description":"Running the source's workflows here to compare; absent when never set","type":"object","properties":{"enabled":{"type":"boolean","description":"Shadow CI runs on mirrored pushes"},"branches":{"type":"array","items":{"type":"string"},"description":"Branch patterns it runs for; the default branch when empty"}},"required":["enabled","branches"],"additionalProperties":false},"hasToken":{"type":"boolean","description":"A token for the source is kept (it is never shown)"}},"required":["provider","sourceUrl","intervalMinutes","lastSyncedAt","lastError","hasToken"],"additionalProperties":false,"description":"How the mirror follows its source"},{"type":"null"}],"description":"Set while it mirrors a source (pushes refused); null for an ordinary repository"},"pushMirror":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The remote repository pushes are copied to"},"lastPushedAt":{"description":"When the last push to it finished (ISO 8601); null before the first","type":["string","null"]},"lastStatus":{"anyOf":[{"type":"string","enum":["ok","failed"]},{"type":"null"}],"description":"How the last push went; null before the first"},"lastError":{"description":"Why the last push failed; null when it did not","type":["string","null"]},"rejectedRefs":{"type":"array","items":{"type":"string"},"description":"Refs the remote refused in the last push because they moved there on their own"}},"required":["url","lastPushedAt","lastStatus","lastError","rejectedRefs"],"additionalProperties":false},{"type":"null"}],"description":"Where every push is copied to; null without a push mirror. The token is never shown"},"forkedFromRepoId":{"description":"The repository it was forked from; null for an original or a deleted parent","type":["string","null"]},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"Lockfiles on the default branch are checked against the vulnerability database"},"maxFileSizeMb":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Largest file a push may add, in MB; null for the platform default of 100"},"defaultWorkflowPermissions":{"type":"string","enum":["restricted","permissive"],"description":"What a workflow job's token may do when its file sets no `permissions:`"},"createdAt":{"type":"string","description":"When it was created (ISO 8601)"},"updatedAt":{"type":"string","description":"When its settings last changed (ISO 8601)"},"cloneUrl":{"description":"The HTTPS clone URL; null in the answer to `update`","type":["string","null"]}},"required":["id","orgId","name","description","homepage","topics","visibility","defaultBranch","isEmpty","isArchived","allowMergeCommit","allowSquashMerge","allowRebaseMerge","deleteBranchOnMerge","sizeBytes","refsVersion","lastPushedAt","importState","mirror","pushMirror","forkedFromRepoId","secretPushProtection","dependencyAlerts","maxFileSizeMb","defaultWorkflowPermissions","createdAt","updatedAt","cloneUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:CreateRepository","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/security/overview":{"get":{"operationId":"git.security.overview","summary":"Open alerts and protection settings for every repository you may see","description":"`git:ListSecurityAlerts` Open alerts and protection settings for every repository you may see.","tags":["Git"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"repoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository"},"name":{"type":"string","description":"Its name"},"visibility":{"type":"string","enum":["private","internal","public"],"description":"Who can see it"},"isArchived":{"type":"boolean","description":"Archived: read-only"},"secretPushProtection":{"type":"boolean","description":"Pushes that add a known credential format are refused"},"dependencyAlerts":{"type":"boolean","description":"The default branch's lockfiles are checked against the vulnerability database"},"secretsBypassed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Secrets pushed past protection and not yet resolved"},"secretsBlocked30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pushes refused for a secret in the last 30 days"},"dependencyCritical":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of critical severity"},"dependencyHigh":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of high severity"},"dependencyOther":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open dependency alerts of medium, low or unknown severity"},"codeScanOpen":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open code scanning alerts on the default branch"}},"required":["repoId","name","visibility","isArchived","secretPushProtection","dependencyAlerts","secretsBypassed","secretsBlocked30d","dependencyCritical","dependencyHigh","dependencyOther","codeScanOpen"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListSecurityAlerts","x-ews-mutates":false,"x-ews-sensitive":false}},"/git/api/ssh-keys":{"get":{"operationId":"git.ssh-keys.list","summary":"List your registered SSH keys","description":"`git:ListAccessTokens` List your registered SSH keys. Guarded by git:ListAccessTokens rather than a key-specific read action — the git descriptor has no ListSshKeys.","tags":["Git"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The key id"},"orgId":{"type":"string","description":"The organization"},"iamUserId":{"type":"string","description":"The IAM user it identifies"},"name":{"type":"string","description":"Its name"},"publicKey":{"type":"string","description":"The public key, as registered"},"fingerprint":{"type":"string","description":"Its SHA256 fingerprint"},"lastUsedAt":{"description":"When it was last used (ISO 8601); null if never","type":["string","null"]},"createdAt":{"type":"string","description":"When it was registered (ISO 8601)"}},"required":["id","orgId","iamUserId","name","publicKey","fingerprint","lastUsedAt","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:ListAccessTokens","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"git.ssh-keys.create","summary":"Register an SSH public key","description":"`git:RegisterSshKey` Register an SSH public key.","tags":["Git"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"A name to recognise the key by, e.g. the laptop"},"publicKey":{"type":"string","minLength":1,"maxLength":4000,"description":"The OpenSSH public key line, e.g. `ssh-ed25519 AAAA… comment`"}},"required":["name","publicKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The key id"},"orgId":{"type":"string","description":"The organization"},"iamUserId":{"type":"string","description":"The IAM user it identifies"},"name":{"type":"string","description":"Its name"},"publicKey":{"type":"string","description":"The public key, as registered"},"fingerprint":{"type":"string","description":"Its SHA256 fingerprint"},"lastUsedAt":{"description":"When it was last used (ISO 8601); null if never","type":["string","null"]},"createdAt":{"type":"string","description":"When it was registered (ISO 8601)"}},"required":["id","orgId","iamUserId","name","publicKey","fingerprint","lastUsedAt","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:RegisterSshKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/git/api/ssh-keys/{id}":{"delete":{"operationId":"git.ssh-keys.delete","summary":"Remove a registered SSH key","description":"`git:DeleteSshKey` Remove a registered SSH key.","tags":["Git"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"description":"No `data`: the answer is `{ success: true }` only"}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"git:DeleteSshKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/access-keys":{"get":{"operationId":"iam.access-keys.list","summary":"List access keys, optionally for one IAM user","description":"`iam:ListAccessKeys` List access keys, optionally for one IAM user.","tags":["Identity"],"parameters":[{"name":"iamUserId","in":"query","required":false,"schema":{"description":"Only the keys of this IAM user; omitted: every key of the organization","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListAccessKeys","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.access-keys.create","summary":"Create an access key and return its secret once","description":"`iam:CreateAccessKey` Create an access key and return its secret once. The secret is in the response and nowhere else. The key signs Deutsche Cloud API calls (`Authorization: EWS-ACCESS-KEY id:secret`) and S3 requests (SigV4: id as the access key id, secret as the secret access key). Every key expires: `expiresAt` is in the response. With `scopePolicy` the key can do only what both the principal and the scope allow.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"iamUserId":{"description":"The ID of the IAM user the key signs in as; omitted: yourself","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expiresInDays":{"description":"Days until the key expires; default the organization’s default (90), at most its maximum (365)","type":"integer","minimum":1,"maximum":3650},"description":{"description":"What the key is for","type":"string","maxLength":256},"scopePolicy":{"description":"A policy document (JSON text) that caps the key: a request needs the principal’s policies AND this document to allow it. E.g. S3 on one bucket: {\"Version\":\"2024-01-01\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:ListObjects\",\"s3:GetObject\"],\"Resource\":[\"rn:ews::<org>:s3:bucket/<name>\",\"rn:ews::<org>:s3:bucket/<name>/object/*\"]}]}","type":"string","maxLength":10240},"actAsMember":{"description":"Must be true when iamUserId is another person’s own IAM user: everything done with the key is recorded as that person, and the audit entry names both","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateAccessKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/access-keys/{id}":{"patch":{"operationId":"iam.access-keys.set-status","summary":"Activate or deactivate an access key","description":"`iam:UpdateAccessKey` Activate or deactivate an access key.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","inactive"],"description":"inactive refuses every request signed with the key until it is set active again"}},"required":["status"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAccessKey","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.access-keys.delete","summary":"Delete an access key","description":"`iam:DeleteAccessKey` Delete an access key.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteAccessKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/access-keys/set-expiry":{"post":{"operationId":"iam.access-keys.set-expiry","summary":"Give every key of the organization that never expires an expiry","description":"`iam:UpdateAccessKey` Give every key of the organization that never expires an expiry. For keys made before keys expired. Keys Deutsche Cloud mints for app machines are left out; role session keys carry their own expiry.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresInDays":{"type":"integer","minimum":1,"maximum":3650,"description":"Days from now, at most the organization’s maximum"}},"required":["expiresInDays"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAccessKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/agent-sessions":{"get":{"operationId":"iam.agent-sessions.list","summary":"List agent sessions, calls waiting for approval and the agent settings","description":"`iam:ListAgentSessions` List agent sessions, calls waiting for approval and the agent settings. Without iam:ListAgentSessions a caller sees only the sessions of their own agents.","tags":["Identity"],"parameters":[{"name":"days","in":"query","required":false,"schema":{"default":7,"description":"How many days of ended sessions to include","type":"integer","minimum":1,"maximum":90}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListAgentSessions","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/agent-sessions/{id}/end":{"post":{"operationId":"iam.agent-sessions.end","summary":"End an agent session; the agent starts over read-only","description":"`iam:EndAgentSession` End an agent session; the agent starts over read-only.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:EndAgentSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/agent-sessions/{id}/revoke-connection":{"post":{"operationId":"iam.agent-sessions.revoke-connection","summary":"Revoke the connection behind a session: OAuth app disconnected, access key refused by MCP","description":"`iam:EndAgentSession` Revoke the connection behind a session: OAuth app disconnected, access key refused by MCP.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:EndAgentSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/agent-sessions/{id}/scope":{"post":{"operationId":"iam.agent-sessions.set-scope","summary":"Allow an agent session to write or destroy for a while, or drop it to read-only","description":"`iam:UpdateAgentSession` Allow an agent session to write or destroy for a while, or drop it to read-only. Raising a session needs a person signed in to the console; an access key or OAuth token is refused, so an agent cannot raise itself. Your own agents need no IAM action.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","enum":["read","write","destructive"],"description":"What the session may do"},"durationMinutes":{"description":"15, 60 or 480. Default: 60 for write, 15 for destructive","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["scope"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAgentSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/agent-sessions/approvals/{id}":{"post":{"operationId":"iam.agent-sessions.approve-call","summary":"Approve one destructive call an agent planned","description":"`iam:UpdateAgentSession` Approve one destructive call an agent planned. Console sign-in only, like set-scope.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAgentSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/agent-sessions/settings":{"put":{"operationId":"iam.agent-sessions.update-settings","summary":"Set the agent rate limits, or switch off changes by every agent","description":"`iam:UpdateAgentSettings` Set the agent rate limits, or switch off changes by every agent. Console sign-in only.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"callsPerMinute":{"type":"integer","minimum":1,"maximum":1000,"description":"Tool calls one agent connection may make per minute (120 until changed)"},"writesPerMinute":{"type":"integer","minimum":1,"maximum":500,"description":"Calls that change something, per agent connection and minute (30 until changed)"},"destructivePerTenMinutes":{"type":"integer","minimum":0,"maximum":500,"description":"Destructive calls per agent connection in ten minutes; 0 allows none (10 until changed)"},"writesDisabled":{"type":"boolean","description":"Switch off changes by every AI agent in the organization"}},"required":["callsPerMinute","writesPerMinute","destructivePerTenMinutes","writesDisabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAgentSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/audit-destinations":{"get":{"operationId":"iam.audit-destinations.list","summary":"List exports and alarms with their delivery state","description":"`iam:ListAuditDestinations` List exports and alarms with their delivery state.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListAuditDestinations","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.audit-destinations.create","summary":"Export to S3, a webhook or syslog over TLS, or alarm by email on matching events","description":"`iam:CreateAuditDestination` Export to S3, a webhook or syslog over TLS, or alarm by email on matching events. Delivers events from now on (update with resumeFrom=start to replay what is stored). filterActions takes globs; empty means every action. A webhook signing secret is returned once.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["s3","webhook","syslog","email"],"description":"Where entries go: an S3 bucket, an https webhook, a syslog receiver over TLS, or email (an alarm)"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"A name, unique in the organization"},"filterActions":{"description":"Action patterns to send, e.g. iam:* or auth:SignIn; empty or omitted: every action","maxItems":50,"type":"array","items":{"type":"string","maxLength":100}},"filterOutcome":{"description":"Send only entries with this outcome: success (Succeeded), error (Failed) or failure (Denied); null or omitted: every outcome","anyOf":[{"type":"string","enum":["success","error","failure"]},{"type":"null"}]},"config":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Settings for the kind. s3: {bucket, accessKeyId, region (default us-east-1), prefix, endpoint (default this platform’s object storage)}; webhook: {url} (https); syslog: {host, port (default 6514), caCertificate (PEM, for a private CA)}; email: {addresses}"},"secretAccessKey":{"description":"The secret key that goes with config.accessKeyId; required for s3, stored encrypted and never returned","type":"string","minLength":16,"maxLength":256}},"required":["kind","name","config"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateAuditDestination","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/audit-destinations/{id}":{"get":{"operationId":"iam.audit-destinations.get","summary":"One export or alarm: cursor, last delivery, last error","description":"`iam:ListAuditDestinations` One export or alarm: cursor, last delivery, last error.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListAuditDestinations","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"iam.audit-destinations.update","summary":"Rename, pause, resume, change the filter, or replay from the start or skip to now","description":"`iam:UpdateAuditDestination` Rename, pause, resume, change the filter, or replay from the start or skip to now.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A new name, unique in the organization","type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9 ._-]+$"},"enabled":{"description":"false pauses delivery; true resumes it where it stopped","type":"boolean"},"filterActions":{"description":"Replaces the action patterns, e.g. iam:*; an empty list sends every action","maxItems":50,"type":"array","items":{"type":"string","pattern":"^[a-z0-9*-]+:[A-Za-z0-9*]+$"}},"filterOutcome":{"description":"Send only entries with this outcome: success (Succeeded), error (Failed) or failure (Denied); null sends every outcome","anyOf":[{"type":"string","enum":["success","error","failure"]},{"type":"null"}]},"resumeFrom":{"description":"now skips every entry not yet delivered; start replays every entry still stored; omitted: delivery carries on where it stands","type":"string","enum":["now","start"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAuditDestination","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.audit-destinations.delete","summary":"Remove an export or alarm","description":"`iam:DeleteAuditDestination` Remove an export or alarm.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteAuditDestination","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/audit-destinations/{id}/test":{"post":{"operationId":"iam.audit-destinations.test","summary":"Send one synthetic event now and report what the destination answered","description":"`iam:TestAuditDestination` Send one synthetic event now and report what the destination answered.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:TestAuditDestination","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/audit-logs":{"get":{"operationId":"iam.audit-logs.list","summary":"Search audit log entries, newest first","description":"`iam:GetAuditLogs` Search audit log entries, newest first. action takes comma-separated globs (iam:*,auth:SignIn); from is inclusive and to exclusive (ISO-8601); principal is exact (user/alice@acme.com, iam-user/ci, role/deployer/run-42). The response carries total.","tags":["Identity"],"parameters":[{"name":"action","in":"query","required":false,"schema":{"description":"Comma-separated action patterns, e.g. iam:*,auth:SignIn; omitted: every action","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"schema":{"description":"success (Succeeded), error (allowed but Failed) or failure (Denied); omitted: every outcome","type":"string","enum":["success","error","failure"]}},{"name":"principal","in":"query","required":false,"schema":{"description":"One principal, exactly: user/alice@acme.com, iam-user/ci, role/deployer/run-42","type":"string","maxLength":300}},{"name":"accessKeyId","in":"query","required":false,"schema":{"description":"Only entries made with this access key ID","type":"string","maxLength":64}},{"name":"ip","in":"query","required":false,"schema":{"description":"Only entries from this source IP address","type":"string","maxLength":64}},{"name":"resourceId","in":"query","required":false,"schema":{"description":"Only entries about this resource ID, exactly","type":"string","maxLength":200}},{"name":"requestId","in":"query","required":false,"schema":{"description":"Only the entries of this request ID","type":"string","maxLength":128}},{"name":"callerType","in":"query","required":false,"schema":{"description":"Only entries by this kind of caller: console session, access key, connected app, CLI session, unauthenticated, SCIM provisioning, or the platform itself","type":"string","enum":["session","access_key","oauth","cli_session","anonymous","scim","system"]}},{"name":"from","in":"query","required":false,"schema":{"description":"ISO-8601 time; entries at or after it (inclusive)","type":"string","maxLength":40}},{"name":"to","in":"query","required":false,"schema":{"description":"ISO-8601 time; entries before it (exclusive)","type":"string","maxLength":40}},{"name":"search","in":"query","required":false,"schema":{"description":"Text to find, ignoring case, in the action, resource, IP address, request parameters, principal, access key ID, request ID, or the person's name or email","type":"string","maxLength":200}},{"name":"limit","in":"query","required":false,"schema":{"description":"Entries per page; default 50","type":"string"}},{"name":"offset","in":"query","required":false,"schema":{"description":"Entries to skip, for the next page; default 0","type":"string"}},{"name":"order","in":"query","required":false,"schema":{"default":"desc","description":"desc lists the newest entry first, asc the oldest; default desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/audit-logs/{id}":{"get":{"operationId":"iam.audit-logs.get","summary":"One audit log entry with its session context, request and response","description":"`iam:GetAuditLogs` One audit log entry with its session context, request and response.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/audit-logs/digests":{"get":{"operationId":"iam.audit-logs.digests","summary":"The hourly Ed25519-signed digests of the chain head, and the public keys","description":"`iam:GetAuditLogs` The hourly Ed25519-signed digests of the chain head, and the public keys.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/audit-logs/export":{"get":{"operationId":"iam.audit-logs.export","summary":"Download every matching entry, oldest first, as JSON lines or CSV","description":"`iam:GetAuditLogs` Download every matching entry, oldest first, as JSON lines or CSV. Same filters as list; at most 1,000,000 rows per download.","tags":["Identity"],"parameters":[{"name":"action","in":"query","required":false,"schema":{"description":"Comma-separated action patterns, e.g. iam:*,auth:SignIn; omitted: every action","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"schema":{"description":"success (Succeeded), error (allowed but Failed) or failure (Denied); omitted: every outcome","type":"string","enum":["success","error","failure"]}},{"name":"principal","in":"query","required":false,"schema":{"description":"One principal, exactly: user/alice@acme.com, iam-user/ci, role/deployer/run-42","type":"string","maxLength":300}},{"name":"accessKeyId","in":"query","required":false,"schema":{"description":"Only entries made with this access key ID","type":"string","maxLength":64}},{"name":"ip","in":"query","required":false,"schema":{"description":"Only entries from this source IP address","type":"string","maxLength":64}},{"name":"resourceId","in":"query","required":false,"schema":{"description":"Only entries about this resource ID, exactly","type":"string","maxLength":200}},{"name":"requestId","in":"query","required":false,"schema":{"description":"Only the entries of this request ID","type":"string","maxLength":128}},{"name":"callerType","in":"query","required":false,"schema":{"description":"Only entries by this kind of caller: console session, access key, connected app, CLI session, unauthenticated, SCIM provisioning, or the platform itself","type":"string","enum":["session","access_key","oauth","cli_session","anonymous","scim","system"]}},{"name":"from","in":"query","required":false,"schema":{"description":"ISO-8601 time; entries at or after it (inclusive)","type":"string","maxLength":40}},{"name":"to","in":"query","required":false,"schema":{"description":"ISO-8601 time; entries before it (exclusive)","type":"string","maxLength":40}},{"name":"search","in":"query","required":false,"schema":{"description":"Text to find, ignoring case, in the action, resource, IP address, request parameters, principal, access key ID, request ID, or the person's name or email","type":"string","maxLength":200}},{"name":"format","in":"query","required":false,"schema":{"description":"jsonl (one JSON object per line) or csv; default jsonl","type":"string","enum":["jsonl","csv"]}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/audit-logs/settings":{"get":{"operationId":"iam.audit-logs.get-settings","summary":"How long entries are kept","description":"`iam:GetAuditLogs` How long entries are kept.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"iam.audit-logs.update-settings","summary":"Set how long entries are kept, 90 to 3650 days","description":"`iam:UpdateAuditLogSettings` Set how long entries are kept, 90 to 3650 days. A daily sweep deletes older entries, never past the newest signed digest. Export to S3 for longer archives.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"type":"integer","minimum":90,"maximum":3650,"description":"Days an audit log entry is kept (400 until changed)"}},"required":["days"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAuditLogSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/audit-logs/verify":{"get":{"operationId":"iam.audit-logs.verify","summary":"Recompute the hash chain and check the signed digests and the head","description":"`iam:GetAuditLogs` Recompute the hash chain and check the signed digests and the head. ok is false on a chain break (an edited, inserted or deleted row), a digest whose signature or hash does not match, or a head past the last row (a cut-off tail).","tags":["Identity"],"parameters":[{"name":"maxRows","in":"query","required":false,"schema":{"description":"Entries to check before stopping, 1 to 2000000; default 200000","type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetAuditLogs","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/cli-auth-policy":{"get":{"operationId":"iam.cli-auth-policy.get","summary":"Show the CLI sign-in policy","description":"`iam:GetCliAuthPolicy` Show the CLI sign-in policy.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetCliAuthPolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"iam.cli-auth-policy.update","summary":"Set the CLI sign-in policy","description":"`iam:UpdateCliAuthPolicy` Set the CLI sign-in policy. A person only, with a fresh Touch ID or passkey confirmation (the CLI asks for it). personalKeyMaxAgeDays: null = no restriction, 0 = people’s access keys refused, N = refused once older than N days. Service accounts and role sessions (OIDC) are never affected. Run dry-run first.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requirePasskeyCli":{"type":"boolean","description":"People's CLI sessions must be opened with Touch ID or a passkey, sensitive commands ask for a fresh confirmation after five minutes, and older CLIs can no longer sign in with a 90-day access key. Service accounts and role sessions are never affected"},"personalKeyMaxAgeDays":{"anyOf":[{"type":"integer","minimum":0,"maximum":3650},{"type":"null"}],"description":"People's own access keys: null = no restriction, 0 = refused, N = refused once older than N days (at most 3650). Keys of service accounts and role sessions, and keys with a scope policy, are never refused"}},"required":["requirePasskeyCli","personalKeyMaxAgeDays"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateCliAuthPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/cli-auth-policy/dry-run":{"post":{"operationId":"iam.cli-auth-policy.dry-run","summary":"Show who and what a proposed policy would affect, changing nothing","description":"`iam:GetCliAuthPolicy` Show who and what a proposed policy would affect, changing nothing. Lists people with neither a passkey nor a Touch ID device key, personal access keys that would be refused, unverified CLI sessions that would stop, and machine keys (never affected).","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requirePasskeyCli":{"type":"boolean","description":"People's CLI sessions must be opened with Touch ID or a passkey, sensitive commands ask for a fresh confirmation after five minutes, and older CLIs can no longer sign in with a 90-day access key. Service accounts and role sessions are never affected"},"personalKeyMaxAgeDays":{"anyOf":[{"type":"integer","minimum":0,"maximum":3650},{"type":"null"}],"description":"People's own access keys: null = no restriction, 0 = refused, N = refused once older than N days (at most 3650). Keys of service accounts and role sessions, and keys with a scope policy, are never refused"}},"required":["requirePasskeyCli","personalKeyMaxAgeDays"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetCliAuthPolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/grants":{"get":{"operationId":"iam.grants.list","summary":"List the grants that exist on one resource","description":"`iam:ListPolicies` List the grants that exist on one resource. Only policies this endpoint wrote — a hand-authored policy mentioning the same resource is not a grant.","tags":["Identity"],"parameters":[{"name":"resource","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"description":"The RN of the resource whose grants to list, one named resource of this organization"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListPolicies","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.grants.create","summary":"Grant capabilities on one resource to a user, group or role","description":"`iam:AttachUserPolicy` Grant capabilities on one resource to a user, group or role. Each capability id stands for a fixed set of IAM actions; the caller must already hold every action being granted, or the call is refused naming the one they lack. The resource must be one named thing in the caller’s own organization — a wildcard such as zone/* is refused, since org-wide reach belongs on the policy pages.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"principal":{"type":"object","properties":{"kind":{"type":"string","enum":["user","group","role"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","id"],"description":"Who receives the capabilities: {kind: user|group|role, id}"},"resource":{"type":"string","minLength":1,"maxLength":500,"description":"The RN of one named resource of this organization; a wildcard is refused"},"capabilities":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"description":"Capability IDs, e.g. repository.push or database.view; each must apply to the resource’s type, and you must hold every action it stands for"}},"required":["principal","resource","capabilities"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AttachUserPolicy","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:AttachGroupPolicy","iam:AttachRolePolicy"]}},"/iam/api/grants/{policyId}":{"delete":{"operationId":"iam.grants.revoke","summary":"Take a grant back and delete the policy it created","description":"`iam:DetachUserPolicy` Take a grant back and delete the policy it created. Refuses any policy this endpoint did not create. The detach action checked is the one matching the principal holding it, and iam:DeletePolicy is checked as well.","tags":["Identity"],"parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DetachUserPolicy","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:DetachGroupPolicy","iam:DetachRolePolicy","iam:DeletePolicy"]}},"/iam/api/groups":{"get":{"operationId":"iam.groups.list","summary":"List groups","description":"`iam:ListGroups` List groups.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListGroups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.groups.create","summary":"Create a group","description":"`iam:CreateGroup` Create a group.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"The group’s name"},"description":{"description":"What the group is for","type":"string","maxLength":512}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/groups/{id}":{"get":{"operationId":"iam.groups.get","summary":"Describe one group","description":"`iam:GetGroup` Describe one group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetGroup","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"iam.groups.update","summary":"Rename or re-describe a group","description":"`iam:UpdateGroup` Rename or re-describe a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A new name","type":"string","minLength":1,"maxLength":128},"description":{"description":"A new description","type":"string","maxLength":512}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateGroup","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.groups.delete","summary":"Delete a group","description":"`iam:DeleteGroup` Delete a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/groups/{id}/members":{"post":{"operationId":"iam.groups.add-member","summary":"Add a user to a group","description":"`iam:AddUserToGroup` Add a user to a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"iamUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the IAM user to add, a user of this organization"}},"required":["iamUserId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AddUserToGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/groups/{id}/members/{userId}":{"delete":{"operationId":"iam.groups.remove-member","summary":"Remove a user from a group","description":"`iam:RemoveUserFromGroup` Remove a user from a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RemoveUserFromGroup","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/groups/{id}/policies":{"post":{"operationId":"iam.groups.attach-policy","summary":"Attach a policy to a group","description":"`iam:AttachGroupPolicy` Attach a policy to a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the policy to attach, a policy of this organization"}},"required":["policyId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AttachGroupPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/groups/{id}/policies/{policyId}":{"delete":{"operationId":"iam.groups.detach-policy","summary":"Detach a policy from a group","description":"`iam:DetachGroupPolicy` Detach a policy from a group.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DetachGroupPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/invitations":{"get":{"operationId":"iam.invitations.list","summary":"List invitations","description":"`iam:ListInvitations` List invitations.","tags":["Identity"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"description":"Only invitations with this status; omitted: every invitation","type":"string","enum":["pending","accepted","expired","cancelled"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListInvitations","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.invitations.create","summary":"Invite someone to the organization","description":"`iam:InviteUser` Invite someone to the organization. role `none` attaches no preset policy; `groupId` / `roleId` add the person to a group of this organization or give them a role when they accept.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The address to invite; the invitation is mailed there"},"role":{"default":"member","description":"The organization role, and its preset policy, the person gets on accepting; none attaches no policy; default member","type":"string","enum":["admin","member","viewer","billing","none"]},"groupId":{"description":"A group of this organization the person joins on accepting","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"roleId":{"description":"A role of this organization the person is given on accepting","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["email"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:InviteUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/invitations/{id}":{"delete":{"operationId":"iam.invitations.cancel","summary":"Cancel a pending invitation","description":"`iam:CancelInvitation` Cancel a pending invitation.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CancelInvitation","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/invitations/{id}/link":{"post":{"operationId":"iam.invitations.link","summary":"Get the link of a pending invitation, to pass on yourself","description":"`iam:GetInvitationLink` Get the link of a pending invitation, to pass on yourself.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetInvitationLink","x-ews-mutates":false,"x-ews-sensitive":true}},"/iam/api/invitations/{id}/resend":{"post":{"operationId":"iam.invitations.resend","summary":"Send a pending invitation again; the link gets 7 more days","description":"`iam:ResendInvitation` Send a pending invitation again; the link gets 7 more days.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ResendInvitation","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/members":{"get":{"operationId":"iam.members.list","summary":"List organization members","description":"`iam:ListMembers` List organization members.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListMembers","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/members/{id}":{"patch":{"operationId":"iam.members.set-role","summary":"Change a member org role","description":"`iam:UpdateMember` Change a member org role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","member","viewer","billing"],"description":"The member’s new organization role; the owner’s cannot be changed"}},"required":["role"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateMember","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.members.remove","summary":"Remove a member from the organization","description":"`iam:RemoveMember` Remove a member from the organization.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RemoveMember","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/members/{id}/revoke-sessions":{"post":{"operationId":"iam.members.revoke-sessions","summary":"Sign a member out of the console everywhere and disconnect their apps","description":"`iam:RevokeUserSessions` Sign a member out of the console everywhere and disconnect their apps. Their browsers are told an administrator signed them out. Access keys are separate credentials and stay; deactivate those under access-keys.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RevokeUserSessions","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/members/{id}/sessions":{"get":{"operationId":"iam.members.sessions","summary":"List a member's console sessions: device, address, sign-in method","description":"`iam:ListUserSessions` List a member's console sessions: device, address, sign-in method.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListUserSessions","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/oidc-providers":{"get":{"operationId":"iam.oidc-providers.list","summary":"List identity providers","description":"`iam:ListOpenIdConnectProviders` List identity providers.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListOpenIdConnectProviders","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.oidc-providers.create","summary":"Register an identity provider","description":"`iam:CreateOpenIdConnectProvider` Register an identity provider.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":512,"description":"The issuer: a public https:// URL equal to the iss claim of the tokens it signs, e.g. https://token.actions.githubusercontent.com"},"audiences":{"description":"The aud values a token may carry; omitted: the console’s own address, the audience the guides tell a job to request","minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},"required":["url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateOpenIdConnectProvider","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/oidc-providers/{id}":{"get":{"operationId":"iam.oidc-providers.get","summary":"Describe one identity provider","description":"`iam:GetOpenIdConnectProvider` Describe one identity provider.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetOpenIdConnectProvider","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"iam.oidc-providers.update","summary":"Change the accepted audiences","description":"`iam:UpdateOpenIdConnectProvider` Change the accepted audiences.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audiences":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":256},"description":"The aud values a token may carry; replaces the whole list"}},"required":["audiences"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateOpenIdConnectProvider","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.oidc-providers.delete","summary":"Remove an identity provider","description":"`iam:DeleteOpenIdConnectProvider` Remove an identity provider.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteOpenIdConnectProvider","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/password-policy":{"get":{"operationId":"iam.password-policy.get","summary":"Show the password policy and the org sign-in URL","description":"`iam:GetPasswordPolicy` Show the password policy and the org sign-in URL.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetPasswordPolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"iam.password-policy.update","summary":"Set the password policy (the whole policy)","description":"`iam:UpdatePasswordPolicy` Set the password policy (the whole policy). Applies to IAM-user console passwords only. `consolePasswordsAllowed: false` turns IAM-user password sign-in off; an enforced SSO connection does too.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"minLength":{"type":"integer","minimum":8,"maximum":128,"description":"The fewest characters a password may have (12 by default)"},"requireUppercase":{"type":"boolean","description":"A password needs an uppercase letter A–Z (true by default)"},"requireLowercase":{"type":"boolean","description":"A password needs a lowercase letter a–z (true by default)"},"requireNumbers":{"type":"boolean","description":"A password needs a digit 0–9 (true by default)"},"requireSymbols":{"type":"boolean","description":"A password needs a character that is not a letter or digit (false by default)"},"maxAgeDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}],"description":"Days after which a password must be changed; null: never (null by default)"},"lockoutThreshold":{"type":"integer","minimum":3,"maximum":20,"description":"Wrong passwords in a row from one address before sign-in from it is locked (5 by default)"},"lockoutMinutes":{"type":"integer","minimum":1,"maximum":1440,"description":"Minutes a lockout lasts (15 by default)"},"maxSessionHours":{"type":"integer","minimum":1,"maximum":168,"description":"Hours a console session of an IAM user lasts before signing in again (12 by default)"},"consolePasswordsAllowed":{"type":"boolean","description":"false turns console password sign-in off for every IAM user of the organization (true by default)"}},"required":["minLength","requireUppercase","requireLowercase","requireNumbers","requireSymbols","maxAgeDays","lockoutThreshold","lockoutMinutes","maxSessionHours","consolePasswordsAllowed"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdatePasswordPolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.password-policy.delete","summary":"Return the password policy to the defaults","description":"`iam:DeletePasswordPolicy` Return the password policy to the defaults.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeletePasswordPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/policies":{"get":{"operationId":"iam.policies.list","summary":"List policies","description":"`iam:ListPolicies` List policies.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListPolicies","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.policies.create","summary":"Create a customer-managed policy","description":"`iam:CreatePolicy` Create a customer-managed policy. `document` is a JSON string, validated by validatePolicyDocument before it is stored.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"The policy’s name"},"description":{"description":"What the policy is for","type":"string","maxLength":512},"document":{"type":"string","minLength":1,"description":"The policy document as JSON text: {\"Version\":\"2024-01-01\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[…],\"Resource\":[…]}]}; checked before it is stored"}},"required":["name","document"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreatePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/policies/{id}":{"get":{"operationId":"iam.policies.get","summary":"Describe one policy","description":"`iam:GetPolicy` Describe one policy.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetPolicy","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"iam.policies.update","summary":"Update a policy document","description":"`iam:UpdatePolicy` Update a policy document.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A new name","type":"string","minLength":1,"maxLength":128},"description":{"description":"A new description","type":"string","maxLength":512},"document":{"description":"A replacement policy document as JSON text; checked before it is stored","type":"string","minLength":1}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdatePolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.policies.delete","summary":"Delete a policy","description":"`iam:DeletePolicy` Delete a policy.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeletePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles":{"get":{"operationId":"iam.roles.list","summary":"List roles","description":"`iam:ListRoles` List roles.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListRoles","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.roles.create","summary":"Create a role","description":"`iam:CreateRole` Create a role.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"The role’s name"},"description":{"description":"What the role is for","type":"string","maxLength":512}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateRole","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}":{"get":{"operationId":"iam.roles.get","summary":"Describe one role","description":"`iam:GetRole` Describe one role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetRole","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"iam.roles.delete","summary":"Delete a role","description":"`iam:DeleteRole` Delete a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteRole","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}/policies":{"post":{"operationId":"iam.roles.attach-policy","summary":"Attach a policy to a role","description":"`iam:AttachRolePolicy` Attach a policy to a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the policy to attach, a policy of this organization"}},"required":["policyId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AttachRolePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}/policies/{policyId}":{"delete":{"operationId":"iam.roles.detach-policy","summary":"Detach a policy from a role","description":"`iam:DetachRolePolicy` Detach a policy from a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DetachRolePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}/sessions":{"get":{"operationId":"iam.roles.list-sessions","summary":"List the federated sessions issued for a role","description":"`iam:GetRole` List the federated sessions issued for a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many sessions, newest first; default 50","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetRole","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/roles/{id}/sessions/revoke":{"post":{"operationId":"iam.roles.revoke-sessions","summary":"Invalidate every temporary credential issued for a role","description":"`iam:RevokeRoleSessions` Invalidate every temporary credential issued for a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RevokeRoleSessions","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}/trust-ci":{"post":{"operationId":"iam.roles.trust-ci","summary":"Let this platform's CI assume the role wherever it trusts GitHub Actions, for the repositories imported or mirrored here","description":"`iam:UpdateAssumeRolePolicy` Let this platform's CI assume the role wherever it trusts GitHub Actions, for the repositories imported or mirrored here. Each Allow statement whose principal is the GitHub Actions identity provider gets a twin for this CI (its provider is added when missing, which needs iam:CreateOpenIdConnectProvider): the same conditions, with repo:<owner>/<repo> mapped to the repository here. GitHub keeps working. Statements that pin only by numeric ids are skipped and listed.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAssumeRolePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/roles/{id}/trust-policy":{"put":{"operationId":"iam.roles.set-trust-policy","summary":"Set which federated workloads (e.g. GitHub Actions jobs) may assume a role","description":"`iam:UpdateAssumeRolePolicy` Set which federated workloads (e.g. GitHub Actions jobs) may assume a role.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"trustPolicy":{"description":"The trust policy, as a JSON object or JSON text: which identity providers, and which token claims, may assume the role; null removes it, so nobody can"}},"required":["trustPolicy"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateAssumeRolePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/simulate":{"post":{"operationId":"iam.policies.simulate","summary":"Test whether a user, role or draft policy allows an action, and why","description":"`iam:SimulatePrincipalPolicy` Test whether a user, role or draft policy allows an action, and why. Give `principal` ({type: user|role, id}), `policyDocuments` (JSON strings, not saved), or both — drafts are then evaluated as if attached. A principal needs iam:SimulatePrincipalPolicy on it, drafts need iam:SimulateCustomPolicy. The answer names the deciding statement, its policy and how that policy reaches the principal (directly, group, role). `context` sets condition keys (sourceIp, multiFactorAuthPresent, currentTime, requestedRegion, availabilityZone, requestProject, resourceProject); a key left out is unknown, as it would be for a request that does not carry it. Bucket policies of S3 are not included.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"principal":{"description":"The user or role to test, as {type: user|role, id}; omitted: only policyDocuments are evaluated","type":"object","properties":{"type":{"type":"string","enum":["user","role"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["type","id"]},"policyDocuments":{"description":"Policy documents (JSON text) that are not saved: with a principal, evaluated as if attached to it; without one, on their own","maxItems":10,"type":"array","items":{"type":"string","minLength":2,"maxLength":65536}},"action":{"type":"string","minLength":3,"maxLength":128,"pattern":"^[a-z0-9-]+:[A-Za-z0-9]+$","description":"The one action to test, e.g. ec2:StartInstances (not a pattern)"},"resource":{"type":"string","minLength":1,"maxLength":1024,"pattern":"^(\\*|rn:(?:dcloud|ews):[^\\s]*)$","description":"The resource name (RN) the request would act on, or *"},"context":{"description":"Condition keys of the imagined request: sourceIp, multiFactorAuthPresent, currentTime (default now), requestedRegion (default your region), availabilityZone; a key left out is unknown","type":"object","properties":{"sourceIp":{"anyOf":[{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"}]},"multiFactorAuthPresent":{"type":"boolean"},"currentTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"requestedRegion":{"type":"string","pattern":"^[a-z]{2,4}\\d$"},"availabilityZone":{"type":"string","pattern":"^[a-z]{2,4}\\d[a-z]$"},"authMethod":{"type":"string","enum":["console","cli-session","access-key","web-identity","oauth"]},"principalType":{"type":"string","enum":["person","service-account","assumed-role"]},"userVerified":{"type":"boolean"},"userVerifiedAgeSeconds":{"type":"integer","minimum":0,"maximum":31536000},"requestProject":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"},"resourceProject":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}}}},"required":["action","resource"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:SimulatePrincipalPolicy","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:SimulateCustomPolicy"]}},"/iam/api/sso-connections":{"get":{"operationId":"iam.sso-connections.list","summary":"List single sign-on connections and their domains","description":"`iam:ListSsoConnections` List single sign-on connections and their domains.","tags":["Identity"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListSsoConnections","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.sso-connections.create","summary":"Connect an OIDC or SAML identity provider (created switched off)","description":"`iam:CreateSsoConnection` Connect an OIDC or SAML identity provider (created switched off). The OIDC client secret is stored encrypted and never returned. A connection signs nobody in until a domain is verified and it is enabled","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"protocol":{"type":"string","const":"oidc"},"name":{"type":"string","minLength":1,"maxLength":100,"description":"A name for the connection, e.g. the identity provider’s"},"defaultRole":{"description":"The organization role a person gets when single sign-on first adds them; default member","type":"string","enum":["admin","member","viewer","billing"]},"oidc":{"type":"object","properties":{"issuer":{"type":"string","minLength":1,"maxLength":512},"clientId":{"type":"string","minLength":1,"maxLength":512},"clientSecret":{"type":"string","minLength":1,"maxLength":4096}},"required":["issuer","clientId","clientSecret"],"description":"For protocol oidc: {issuer, clientId, clientSecret} of the app registered at the identity provider"}},"required":["protocol","name","oidc"]},{"type":"object","properties":{"protocol":{"type":"string","const":"saml"},"name":{"type":"string","minLength":1,"maxLength":100,"description":"A name for the connection, e.g. the identity provider’s"},"defaultRole":{"description":"The organization role a person gets when single sign-on first adds them; default member","type":"string","enum":["admin","member","viewer","billing"]},"saml":{"type":"object","properties":{"idpSsoUrl":{"type":"string","maxLength":2048,"format":"uri"},"idpEntityId":{"type":"string","minLength":1,"maxLength":1024},"idpCertificate":{"type":"string","minLength":1,"maxLength":65536},"allowSha1":{"type":"boolean"}},"required":["idpSsoUrl","idpEntityId","idpCertificate"],"description":"For protocol saml: {idpSsoUrl (https), idpEntityId, idpCertificate (PEM), allowSha1 (default false)} from the identity provider"}},"required":["protocol","name","saml"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}":{"get":{"operationId":"iam.sso-connections.get","summary":"Describe one connection, with the values to enter at the identity provider","description":"`iam:GetSsoConnection` Describe one connection, with the values to enter at the identity provider.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetSsoConnection","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"iam.sso-connections.update","summary":"Change settings, turn the connection on or off, or enforce it","description":"`iam:UpdateSsoConnection` Change settings, turn the connection on or off, or enforce it. enabled requires at least one verified domain; enforced requires enabled. Enforcing refuses password sign-in for addresses on the verified domains, except the organization owner","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A new name for the connection","type":"string","minLength":1,"maxLength":100},"enabled":{"description":"true lets people sign in through the connection (needs a verified domain); false stops it and its enforcement","type":"boolean"},"enforced":{"description":"true refuses password sign-in for addresses on the verified domains, except the organization owner; needs enabled","type":"boolean"},"defaultRole":{"description":"The organization role a person gets when single sign-on first adds them","type":"string","enum":["admin","member","viewer","billing"]},"groupsClaim":{"description":"The OIDC claim or SAML attribute that lists the person’s groups at the identity provider (groups until changed)","type":"string","minLength":1,"maxLength":256},"oidc":{"description":"New OIDC settings {issuer, clientId, clientSecret}; leave out clientSecret to keep the stored one. A new issuer or client ID unlinks the accounts linked through the old one","type":"object","properties":{"issuer":{"type":"string","minLength":1,"maxLength":512},"clientId":{"type":"string","minLength":1,"maxLength":512},"clientSecret":{"type":"string","minLength":1,"maxLength":4096}},"required":["issuer","clientId"]},"saml":{"description":"New SAML settings {idpSsoUrl, idpEntityId, idpCertificate, allowSha1}. A new URL, entity ID or certificate unlinks the accounts linked through the old one","type":"object","properties":{"idpSsoUrl":{"type":"string","maxLength":2048,"format":"uri"},"idpEntityId":{"type":"string","minLength":1,"maxLength":1024},"idpCertificate":{"type":"string","minLength":1,"maxLength":65536},"allowSha1":{"type":"boolean"}},"required":["idpSsoUrl","idpEntityId","idpCertificate"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.sso-connections.delete","summary":"Remove a connection; accounts it created stay members","description":"`iam:DeleteSsoConnection` Remove a connection; accounts it created stay members.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/domains":{"post":{"operationId":"iam.sso-connections.add-domain","summary":"Claim an email domain; returns the TXT record that proves it","description":"`iam:UpdateSsoConnection` Claim an email domain; returns the TXT record that proves it.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":3,"maxLength":253,"description":"An email domain the organization owns, e.g. acme.com"}},"required":["domain"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/domains/{domainId}":{"delete":{"operationId":"iam.sso-connections.remove-domain","summary":"Remove a domain; a connection left without a verified one is switched off","description":"`iam:UpdateSsoConnection` Remove a domain; a connection left without a verified one is switched off.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/domains/{domainId}/verify":{"post":{"operationId":"iam.sso-connections.verify-domain","summary":"Look up the TXT record and mark the domain verified when it matches","description":"`iam:VerifySsoDomain` Look up the TXT record and mark the domain verified when it matches.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:VerifySsoDomain","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/group-mappings":{"get":{"operationId":"iam.sso-connections.group-mappings","summary":"The IdP group → IAM group mappings and the claim groups are read from","description":"`iam:GetSsoConnection` The IdP group → IAM group mappings and the claim groups are read from.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetSsoConnection","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"iam.sso-connections.set-group-mappings","summary":"Replace the IdP group → IAM group mappings","description":"`iam:UpdateSsoConnection` Replace the IdP group → IAM group mappings. At every SSO sign-in, membership in each mapped IAM group is set to what the IdP says; memberships added by hand and SCIM-managed groups are never touched. A leading / on a group path is ignored.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"idpGroup":{"type":"string","minLength":1,"maxLength":512},"iamGroupId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["idpGroup","iamGroupId"]},"description":"Every mapping, as {idpGroup, iamGroupId}: idpGroup as the identity provider sends it (a name, a path, a DN or an object ID); an empty list removes them all"}},"required":["mappings"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateSsoConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/scim-tokens":{"get":{"operationId":"iam.sso-connections.scim-tokens","summary":"List the SCIM provisioning tokens of a connection, and the SCIM base URL","description":"`iam:ListScimTokens` List the SCIM provisioning tokens of a connection, and the SCIM base URL.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListScimTokens","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.sso-connections.create-scim-token","summary":"Create a SCIM token for the IdP; the token is returned once","description":"`iam:CreateScimToken` Create a SCIM token for the IdP; the token is returned once.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"A name for the token, e.g. the identity provider that uses it"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateScimToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/sso-connections/{id}/scim-tokens/{tokenId}":{"delete":{"operationId":"iam.sso-connections.delete-scim-token","summary":"Revoke a SCIM token","description":"`iam:DeleteScimToken` Revoke a SCIM token.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"tokenId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteScimToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users":{"get":{"operationId":"iam.users.list","summary":"List IAM users","description":"`iam:ListUsers` List IAM users.","tags":["Identity"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many users, newest first; default 1000","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListUsers","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.users.create","summary":"Create an IAM user or service account","description":"`iam:CreateUser` Create an IAM user or service account.","tags":["Identity"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9_-]+$","description":"The user name, unique in the organization; an IAM user with a console password signs in with it"},"displayName":{"description":"A readable name shown in the console","type":"string","maxLength":128},"type":{"default":"user","description":"service_account for a program, which uses access keys and never a console password; default user","type":"string","enum":["user","service_account"]}},"required":["username"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}":{"get":{"operationId":"iam.users.get","summary":"Describe one IAM user","description":"`iam:GetUser` Describe one IAM user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetUser","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"iam.users.delete","summary":"Delete an IAM user","description":"`iam:DeleteUser` Delete an IAM user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/cli":{"get":{"operationId":"iam.users.cli-access","summary":"A member's CLI devices (Touch ID keys) and their CLI sessions in this organization","description":"`iam:ListUserSessions` A member's CLI devices (Touch ID keys) and their CLI sessions in this organization. Each device says whether this organization blocked it.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListUserSessions","x-ews-mutates":false,"x-ews-sensitive":false}},"/iam/api/users/{id}/cli/device-keys/{keyId}/block":{"post":{"operationId":"iam.users.block-device-key","summary":"Block a member's CLI device in this organization","description":"`iam:BlockUserDeviceKey` Block a member's CLI device in this organization. It signs in here no more and its CLI sessions here end now. The device keeps working in other organizations; only its owner removes it.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:BlockUserDeviceKey","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.users.unblock-device-key","summary":"Lift this organization's block on a member's CLI device","description":"`iam:UnblockUserDeviceKey` Lift this organization's block on a member's CLI device.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UnblockUserDeviceKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/cli/sessions/{sessionId}":{"delete":{"operationId":"iam.users.end-cli-session","summary":"End one of a member's CLI sessions in this organization","description":"`iam:RevokeUserSessions` End one of a member's CLI sessions in this organization.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RevokeUserSessions","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/login-profile":{"get":{"operationId":"iam.users.get-login-profile","summary":"Show an IAM user's console access","description":"`iam:GetLoginProfile` Show an IAM user's console access. Enabled or not, whether a new password is due, locked until, last sign-in, second factors, and the org sign-in URL. 404 when the user has no console password.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:GetLoginProfile","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"iam.users.create-login-profile","summary":"Give an IAM user a console password","description":"`iam:CreateLoginProfile` Give an IAM user a console password. The user signs in at /login/<org alias> with the user name and this password. Pass `password` (checked against the password policy) or `generatePassword: true`; a generated one is returned once in `generatedPassword`. Users of type `user` only.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"description":"The password to set, checked against the organization's password policy; leave out with generatePassword","type":"string","minLength":1,"maxLength":256},"generatePassword":{"description":"true: a password that meets the policy is made for you and returned once, in generatedPassword","type":"boolean"},"passwordResetRequired":{"default":true,"description":"The user must choose a new password at the first sign-in; default true","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:CreateLoginProfile","x-ews-mutates":true,"x-ews-sensitive":false},"patch":{"operationId":"iam.users.update-login-profile","summary":"Reset, unlock, or turn on/off an IAM user's console password","description":"`iam:UpdateLoginProfile` Reset, unlock, or turn on/off an IAM user's console password. A new password ends the user’s sessions and, unless `passwordResetRequired: false`, must be changed at the next sign-in. `enabled: false` ends their sessions at once.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"description":"A new password, checked against the organization's password policy; ends the user's sessions","type":"string","minLength":1,"maxLength":256},"generatePassword":{"description":"true: a new password is made for you and returned once, in generatedPassword; ends the user's sessions","type":"boolean"},"passwordResetRequired":{"description":"The user must choose a new password at the next sign-in; with a new password, default true","type":"boolean"},"enabled":{"description":"false turns console sign-in off and ends the user's sessions at once (the password is kept); true turns it on again","type":"boolean"},"unlock":{"description":"true lifts a lockout after too many wrong passwords","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:UpdateLoginProfile","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"iam.users.delete-login-profile","summary":"Remove an IAM user's console password","description":"`iam:DeleteLoginProfile` Remove an IAM user's console password. Ends their console sessions. Their second factors are kept.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeleteLoginProfile","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/mfa":{"delete":{"operationId":"iam.users.deactivate-mfa","summary":"Remove an IAM user's second factors","description":"`iam:DeactivateMfaDevice` Remove an IAM user's second factors. Authenticator app, recovery codes and passkeys of the console sign-in; ends its sessions. For a lost phone: an IAM user has no mailbox to recover with.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DeactivateMfaDevice","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/policies":{"post":{"operationId":"iam.users.attach-policy","summary":"Attach a policy directly to a user","description":"`iam:AttachUserPolicy` Attach a policy directly to a user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the policy to attach, a policy of this organization"}},"required":["policyId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AttachUserPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/policies/{policyId}":{"delete":{"operationId":"iam.users.detach-policy","summary":"Detach a policy from a user","description":"`iam:DetachUserPolicy` Detach a policy from a user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:DetachUserPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/roles":{"post":{"operationId":"iam.users.assign-role","summary":"Assign a role to a user","description":"`iam:AssignUserRole` Assign a role to a user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the role to assign, a role of this organization"}},"required":["roleId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:AssignUserRole","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/{id}/roles/{roleId}":{"delete":{"operationId":"iam.users.remove-role","summary":"Remove a role from a user","description":"`iam:RemoveUserRole` Remove a role from a user.","tags":["Identity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:RemoveUserRole","x-ews-mutates":true,"x-ews-sensitive":false}},"/iam/api/users/who-can":{"get":{"operationId":"iam.users.who-can","summary":"List the principals allowed to perform an action on a resource today","description":"`iam:ListUsers` List the principals allowed to perform an action on a resource today. The same evaluation the routes perform, over every active principal of the organization.","tags":["Identity"],"parameters":[{"name":"action","in":"query","required":true,"schema":{"type":"string","description":"One action, e.g. git:PushRepository"}},{"name":"resource","in":"query","required":true,"schema":{"type":"string","description":"The RN of a resource of this organization, or * for every resource"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"iam:ListUsers","x-ews-mutates":false,"x-ews-sensitive":false}},"/kafka/api/ca-bundle":{"get":{"operationId":"kafka.clusters.ca-bundle","summary":"The platform CA (PEM) the clusters’ certificates chain to: the clients’ truststore","description":"`kafka:DescribeKafkaClusters` The platform CA (PEM) the clusters’ certificates chain to: the clients’ truststore.","tags":["Apache Kafka"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/kafka/api/clusters":{"get":{"operationId":"kafka.clusters.list","summary":"List Kafka clusters","description":"`kafka:DescribeKafkaClusters` List Kafka clusters.","tags":["Apache Kafka"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"kafka.clusters.create","summary":"Create a Kafka cluster","description":"`kafka:CreateKafkaCluster` Create a Kafka cluster. Private: without vpcId it joins the default VPC, where deployed apps run. Clients connect with bootstrapServers (every node’s address, port 9093), SASL_SSL and SCRAM-SHA-512, trusting the CA bundle. `creating` until every node is in the quorum and the admin user is in place, usually 3–5 minutes. The admin password is filed in Secrets as KAFKA_<IDENTIFIER>_ADMIN_PASSWORD. With nodes: 1 nothing is replicated. Messages are not backed up.","tags":["Apache Kafka"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from node-types with at least 2 GB of memory, e.g. performance-2. Provider type names still accepted, deprecated."},"nodes":{"default":1,"description":"1: one machine, partitions NOT replicated. 3: one KRaft quorum across zones; replication factor 3, min.insync.replicas 2","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"engineVersion":{"default":"4.4.0","type":"string","enum":["4.4.0","4.3.2"]},"volumeSizeGib":{"default":20,"description":"Each node’s data volume; retention is by time unless retention.bytes is set","type":"integer","minimum":10,"maximum":10000},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"snapshotId":{"description":"Make the cluster from this definitions snapshot (topics and users with their passwords; no messages); needs kafka:CreateKafkaCluster on the snapshot, and at least the snapshot’s node count","type":"string","pattern":"^kfs-[0-9a-f]{12}$"},"alarmEmails":{"default":[],"description":"Who the default alarms in Monitoring email (no quorum, offline partitions, under min ISR, under-replicated, disk); nobody by default","maxItems":10,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"tieredStorage":{"default":false,"description":"Tiered storage from the start: topics with remote.storage.enable keep older segments in a bucket of the organization’s object storage (kafka.tiered.gb_month), encrypted on the nodes. Long retention, not a backup","type":"boolean"}},"required":["identifier","nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}":{"get":{"operationId":"kafka.clusters.get","summary":"One cluster with its nodes (state, active controller, partition leaders, disk), users, the quorum, partition health and consumer-group lag","description":"`kafka:DescribeKafkaClusters` One cluster with its nodes (state, active controller, partition leaders, disk), users, the quorum, partition health and consumer-group lag.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"kafka.clusters.delete","summary":"Delete a cluster, its machines, volumes, every topic and message, and its passwords","description":"`kafka:DeleteKafkaCluster` Delete a cluster, its machines, volumes, every topic and message, and its passwords.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DeleteKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/events":{"get":{"operationId":"kafka.clusters.events","summary":"Activity: provisioning, nodes down and back, the controller moving, under-replicated partitions, users and topics applied, upgrades","description":"`kafka:DescribeKafkaClusters` Activity: provisioning, nodes down and back, the controller moving, under-replicated partitions, users and topics applied, upgrades.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/maintenance/cancel":{"post":{"operationId":"kafka.clusters.cancel-maintenance","summary":"Stop an upgrade or patch run; nodes already done stay done","description":"`kafka:UpgradeKafkaCluster` Stop an upgrade or patch run; nodes already done stay done.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpgradeKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/maintenance/resume":{"post":{"operationId":"kafka.clusters.resume-maintenance","summary":"Resume a paused upgrade or patch run (its current node starts again)","description":"`kafka:UpgradeKafkaCluster` Resume a paused upgrade or patch run (its current node starts again).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpgradeKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/patch":{"post":{"operationId":"kafka.clusters.patch","summary":"Patch the nodes’ operating system now, one node at a time (a reboot if the kernel asks)","description":"`kafka:UpgradeKafkaCluster` Patch the nodes’ operating system now, one node at a time (a reboot if the kernel asks). Security updates also install nightly by themselves; reboots then happen in the platform window, one node of a cluster at a time, only while every partition is in sync.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpgradeKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/reboot":{"post":{"operationId":"kafka.clusters.reboot","summary":"Restart one node (the first unless nodeId names another) — with 3 nodes, a failover test","description":"`kafka:RebootKafkaNode` Restart one node (the first unless nodeId names another) — with 3 nodes, a failover test.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","pattern":"^kfk-[0-9a-f]{12}-[0-2]$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:RebootKafkaNode","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/snapshots":{"post":{"operationId":"kafka.snapshots.create","summary":"Snapshot a cluster’s topics and users now (kept until deleted, 20 per cluster)","description":"`kafka:CreateKafkaSnapshot` Snapshot a cluster’s topics and users now (kept until deleted, 20 per cluster). Topics made over the protocol are taken from the latest cluster view; when it is over 10 minutes old the snapshot is marked partial.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/tiered-storage":{"post":{"operationId":"kafka.clusters.enable-tiered-storage","summary":"Turn tiered storage on: a bucket in the organization’s object storage, then each node restarts with the plugin, one at a time","description":"`kafka:EnableKafkaTieredStorage` Turn tiered storage on: a bucket in the organization’s object storage, then each node restarts with the plugin, one at a time. tieredStorage.state is `enabling` while the nodes restart (like an upgrade: controlled shutdown, back in every ISR before the next) and `on` after the last; topics can then set remote.storage.enable. One node: the cluster is down while it restarts. Remote segments are encrypted on the nodes; the bucket (named after the cluster) is read-only in the S3 console and deleted with the cluster. Billed per GB-month stored (kafka.tiered.gb_month).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true; false is refused (turn it off per topic, or delete the cluster)"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:EnableKafkaTieredStorage","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/topics":{"get":{"operationId":"kafka.topics.list","summary":"List topics, managed and not, with partitions, replication health and settings","description":"`kafka:DescribeKafkaTopics` List topics, managed and not, with partitions, replication health and settings.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaTopics","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"kafka.topics.create","summary":"Declare a topic; the cluster creates it within a minute (`applied: true`)","description":"`kafka:CreateKafkaTopic` Declare a topic; the cluster creates it within a minute (`applied: true`).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$"},"partitions":{"default":3,"type":"integer","minimum":1,"maximum":1000},"replicationFactor":{"description":"Default 3 on a 3-node cluster, 1 on one node","type":"integer","minimum":1,"maximum":3},"configs":{"default":{},"type":"object","properties":{"retention.ms":{"description":"How long messages are kept; -1 = forever","type":"string"},"retention.bytes":{"description":"Per partition: oldest segments go above this; -1 = no limit","type":"string"},"cleanup.policy":{"type":"string","enum":["delete","compact","compact,delete"]},"max.message.bytes":{"description":"Largest record batch, 1 KiB – 100 MiB","type":"string"},"min.insync.replicas":{"description":"acks=all writes need this many in-sync replicas","type":"string","enum":["1","2","3"]},"remote.storage.enable":{"description":"Tiered storage: older segments move to the cluster’s bucket (cluster tiered storage must be on; not on compacted topics). Turning it off deletes the remote data and needs deleteRemoteData","type":"string","enum":["true","false"]},"local.retention.ms":{"description":"With tiered storage: how long segments stay on the brokers too (default 24 h, at most retention.ms)","type":"string"},"local.retention.bytes":{"description":"With tiered storage: per partition, how much stays on the brokers too","type":"string"},"remote.log.copy.disable":{"description":"With tiered storage: true pauses the uploads (what is remote stays readable; new segments stay on the brokers until set back)","type":"string","enum":["true","false"]}},"description":"Topic settings as Kafka strings; a key left out uses the broker default (7 days retention)"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaTopic","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/topics/{topic}":{"patch":{"operationId":"kafka.topics.update","summary":"Add partitions or change a managed topic’s settings","description":"`kafka:UpdateKafkaTopic` Add partitions or change a managed topic’s settings. A setting changed over the Kafka protocol is set back and said in Activity.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"topic","in":"path","required":true,"schema":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partitions":{"description":"Can only grow","type":"integer","minimum":1,"maximum":1000},"configs":{"description":"The whole set: a key left out goes back to the broker default","type":"object","properties":{"retention.ms":{"description":"How long messages are kept; -1 = forever","type":"string"},"retention.bytes":{"description":"Per partition: oldest segments go above this; -1 = no limit","type":"string"},"cleanup.policy":{"type":"string","enum":["delete","compact","compact,delete"]},"max.message.bytes":{"description":"Largest record batch, 1 KiB – 100 MiB","type":"string"},"min.insync.replicas":{"description":"acks=all writes need this many in-sync replicas","type":"string","enum":["1","2","3"]},"remote.storage.enable":{"description":"Tiered storage: older segments move to the cluster’s bucket (cluster tiered storage must be on; not on compacted topics). Turning it off deletes the remote data and needs deleteRemoteData","type":"string","enum":["true","false"]},"local.retention.ms":{"description":"With tiered storage: how long segments stay on the brokers too (default 24 h, at most retention.ms)","type":"string"},"local.retention.bytes":{"description":"With tiered storage: per partition, how much stays on the brokers too","type":"string"},"remote.log.copy.disable":{"description":"With tiered storage: true pauses the uploads (what is remote stays readable; new segments stay on the brokers until set back)","type":"string","enum":["true","false"]}}},"deleteRemoteData":{"default":false,"description":"Required to turn remote.storage.enable off: every message the topic holds in object storage is deleted (kafka:DeleteKafkaTopicRemoteData)","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpdateKafkaTopic","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"kafka.topics.delete","summary":"Delete a managed topic and its messages","description":"`kafka:DeleteKafkaTopic` Delete a managed topic and its messages.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"topic","in":"path","required":true,"schema":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DeleteKafkaTopic","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/topics/{topic}/adopt":{"post":{"operationId":"kafka.topics.adopt","summary":"Make a topic created over the protocol managed, with its current settings","description":"`kafka:CreateKafkaTopic` Make a topic created over the protocol managed, with its current settings.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"topic","in":"path","required":true,"schema":{"type":"string","pattern":"^(?!__)[a-zA-Z0-9._-]{1,249}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaTopic","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/upgrade":{"post":{"operationId":"kafka.clusters.upgrade","summary":"Roll the cluster to a newer Kafka release, one node at a time","description":"`kafka:UpgradeKafkaCluster` Roll the cluster to a newer Kafka release, one node at a time. Same minor or the next (upgradeTargets); no downgrades. Each node stops with a controlled shutdown, restarts on the new image and must be back in every ISR before the next; the active controller goes last; a node that does not come back pauses the rollout. After the last node the feature versions (metadata.version) are finalised.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","enum":["4.4.0","4.3.2"]}},"required":["version"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpgradeKafkaCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/users":{"get":{"operationId":"kafka.users.list","summary":"List a cluster’s users (admin, yours, the event bus’s)","description":"`kafka:DescribeKafkaUsers` List a cluster’s users (admin, yours, the event bus’s).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaUsers","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"kafka.users.create","summary":"Create a user with ACL grants; its password is filed in Secrets","description":"`kafka:CreateKafkaUser` Create a user with ACL grants; its password is filed in Secrets. The cluster applies it within a minute (`applied: true`).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"},"acls":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","enum":["topic","group","transactional_id"],"description":"What the grant is on: topics, consumer groups or transactional ids"},"name":{"type":"string","minLength":1,"maxLength":249,"description":"A name, a prefix (patternType \"prefixed\"), or \"*\" for every one"},"patternType":{"default":"literal","type":"string","enum":["literal","prefixed"]},"access":{"type":"string","enum":["read","write","readwrite","all"],"description":"topic: read (consume), write (produce), readwrite, all (also create/delete/alter); group: read joins it; transactional_id: write"}},"required":["resourceType","name","access"]}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/users/{userName}":{"patch":{"operationId":"kafka.users.update","summary":"Replace a user’s ACL grants (added before the old ones are removed)","description":"`kafka:UpdateKafkaUser` Replace a user’s ACL grants (added before the old ones are removed).","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acls":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","enum":["topic","group","transactional_id"],"description":"What the grant is on: topics, consumer groups or transactional ids"},"name":{"type":"string","minLength":1,"maxLength":249,"description":"A name, a prefix (patternType \"prefixed\"), or \"*\" for every one"},"patternType":{"default":"literal","type":"string","enum":["literal","prefixed"]},"access":{"type":"string","enum":["read","write","readwrite","all"],"description":"topic: read (consume), write (produce), readwrite, all (also create/delete/alter); group: read joins it; transactional_id: write"}},"required":["resourceType","name","access"]}}},"required":["acls"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:UpdateKafkaUser","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"kafka.users.delete","summary":"Delete a user, its ACLs and its secret","description":"`kafka:DeleteKafkaUser` Delete a user, its ACLs and its secret.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DeleteKafkaUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/clusters/{id}/users/{userName}/rotate-password":{"post":{"operationId":"kafka.users.rotate-password","summary":"Replace a user’s password with a new Secrets version","description":"`kafka:RotateKafkaUserPassword` Replace a user’s password with a new Secrets version. Applied within a minute; new connections need the new password then, open ones live until they reconnect. Redeploy bound apps.","tags":["Apache Kafka"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:RotateKafkaUserPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/node-types":{"get":{"operationId":"kafka.clusters.node-types","summary":"The machine types a node can run on (2 GB and up), with price and stock","description":"`kafka:DescribeKafkaClusters` The machine types a node can run on (2 GB and up), with price and stock.","tags":["Apache Kafka"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/kafka/api/replications":{"get":{"operationId":"kafka.replications.list","summary":"List replications with their state, lag and failover result","description":"`kafka:DescribeKafkaReplications` List replications with their state, lag and failover result.","tags":["Apache Kafka"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaReplications","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"kafka.replications.create","summary":"Replicate topics and consumer-group offsets from one cluster into another","description":"`kafka:CreateKafkaReplication` Replicate topics and consumer-group offsets from one cluster into another. Needs kafka:CreateKafkaReplication on the target cluster and kafka:ReplicateKafkaCluster on the source. Both clusters available, in one VPC; the target made after 2026-11-15 (its nodes run the Kafka Connect worker; no extra charge, it uses the target nodes’ memory and CPU). Topic names are kept, so a cycle or two sources writing matching topics into one target is refused. The source gets a read-only user (ews-mirror-…). Copying starts from the oldest retained message; group offsets are synced to the copy every 5 s. At-least-once: a group that moves re-reads a few messages per partition. At most 3 replications into one cluster.","tags":["Apache Kafka"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"sourceClusterId":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$","description":"The cluster copied from"},"targetClusterId":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$","description":"The cluster copied into (its nodes run MirrorMaker 2); in the same VPC"},"topics":{"default":["*"],"description":"Exact names or prefixes ending in *; default every topic, also ones made later","minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^(\\*|[a-zA-Z0-9._-]{1,249}\\*?)$"}},"groups":{"default":["*"],"description":"Consumer groups whose offsets are translated onto the copy; default every one","minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^(\\*|[a-zA-Z0-9._-]{1,249}\\*?)$"}}},"required":["name","sourceClusterId","targetClusterId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:CreateKafkaReplication","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/replications/{replicationId}":{"get":{"operationId":"kafka.replications.get","summary":"One replication: state, messages behind per topic, the connectors and their tasks, the groups synced onto the copy","description":"`kafka:DescribeKafkaReplications` One replication: state, messages behind per topic, the connectors and their tasks, the groups synced onto the copy.","tags":["Apache Kafka"],"parameters":[{"name":"replicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^kfr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaReplications","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"kafka.replications.delete","summary":"Delete a replication: copying stops, the copied topics stay on the target, the source’s mirror user goes","description":"`kafka:DeleteKafkaReplication` Delete a replication: copying stops, the copied topics stay on the target, the source’s mirror user goes.","tags":["Apache Kafka"],"parameters":[{"name":"replicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^kfr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DeleteKafkaReplication","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/replications/{replicationId}/failover":{"post":{"operationId":"kafka.replications.failover","summary":"Fail over: copying stops for good; consumers continue on the target from their translated offsets","description":"`kafka:FailoverKafkaReplication` Fail over: copying stops for good; consumers continue on the target from their translated offsets. Works with the source down: the offsets synced last stand. Copying stops within a minute (`failed_over`); `failover.groups` lists each group on the copy with its lag there. Move consumers (same group id) and producers to the target’s bootstrap servers. There is no failback: replicate the other way into a fresh cluster.","tags":["Apache Kafka"],"parameters":[{"name":"replicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^kfr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:FailoverKafkaReplication","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/snapshots":{"get":{"operationId":"kafka.snapshots.list","summary":"List snapshots, optionally of one cluster","description":"`kafka:DescribeKafkaSnapshots` List snapshots, optionally of one cluster.","tags":["Apache Kafka"],"parameters":[{"name":"clusterId","in":"query","required":false,"schema":{"type":"string","pattern":"^kfk-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaSnapshots","x-ews-mutates":false,"x-ews-sensitive":false}},"/kafka/api/snapshots/{snapshotId}":{"get":{"operationId":"kafka.snapshots.get","summary":"One snapshot: its topics and user names, size, whether it is partial","description":"`kafka:DescribeKafkaSnapshots` One snapshot: its topics and user names, size, whether it is partial.","tags":["Apache Kafka"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^kfs-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"kafka.snapshots.delete","summary":"Delete a snapshot and its stored copy","description":"`kafka:DeleteKafkaSnapshot` Delete a snapshot and its stored copy.","tags":["Apache Kafka"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^kfs-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DeleteKafkaSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/kafka/api/versions":{"get":{"operationId":"kafka.clusters.versions","summary":"The Apache Kafka releases a new cluster may run","description":"`kafka:DescribeKafkaClusters` The Apache Kafka releases a new cluster may run.","tags":["Apache Kafka"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kafka:DescribeKafkaClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/kms/api/keys":{"get":{"operationId":"kms.keys.list","summary":"List keys","description":"`kms:ListKeys` List keys.","tags":["KMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ListKeys","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"kms.keys.create","summary":"Create a key","description":"`kms:CreateKey` Create a key.","tags":["KMS"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,62}$"},"description":{"type":"string","maxLength":256},"usage":{"default":"encrypt_decrypt","type":"string","const":"encrypt_decrypt"},"origin":{"default":"ews","type":"string","enum":["ews","external"]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:CreateKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}":{"get":{"operationId":"kms.keys.get","summary":"Describe one key","description":"`kms:GetKey` Describe one key.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:GetKey","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"kms.keys.set-status","summary":"Enable, disable or rename a key, or change its description","description":"`kms:UpdateKey` Enable, disable or rename a key, or change its description.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["enabled","disabled"]},"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,62}$"},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:UpdateKey","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"kms.keys.delete","summary":"Delete a key whose waiting period has elapsed","description":"`kms:ScheduleKeyDeletion` Delete a key whose waiting period has elapsed. Guarded by kms:ScheduleKeyDeletion rather than a delete-specific action — a key must be scheduled first, so this only finishes what that started. 409 before deletionScheduledAt: the waiting period cannot be cut short, only cancelled.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ScheduleKeyDeletion","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/cancel-deletion":{"post":{"operationId":"kms.keys.cancel-deletion","summary":"Cancel a pending key deletion","description":"`kms:CancelKeyDeletion` Cancel a pending key deletion. The key returns to the status it had when the deletion was scheduled (enabled or disabled). 409 when no deletion is scheduled.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:CancelKeyDeletion","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/decrypt":{"post":{"operationId":"kms.keys.decrypt","summary":"Decrypt a ciphertext blob with a key","description":"`kms:Decrypt` Decrypt a ciphertext blob with a key.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ciphertext":{"type":"string","minLength":1},"iv":{"type":"string","minLength":1},"tag":{"type":"string","minLength":1}},"required":["ciphertext","iv","tag"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:Decrypt","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/encrypt":{"post":{"operationId":"kms.keys.encrypt","summary":"Encrypt UTF-8 plaintext with a key","description":"`kms:Encrypt` Encrypt UTF-8 plaintext with a key.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plaintext":{"type":"string","minLength":1}},"required":["plaintext"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:Encrypt","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/import":{"post":{"operationId":"kms.keys.import","summary":"Import your wrapped key material; a pending_import key becomes enabled","description":"`kms:ImportKeyMaterial` Import your wrapped key material; a pending_import key becomes enabled. Re-importing is accepted only for the same material (checked by key check value), so data encrypted under the key opens again. Optional `expiresAt`: the platform deletes the material then, as DeleteImportedKeyMaterial would.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"importToken":{"type":"string","minLength":10,"maxLength":200},"encryptedKeyMaterial":{"type":"string","minLength":1,"maxLength":4096},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["importToken","encryptedKeyMaterial"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ImportKeyMaterial","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/import-parameters":{"post":{"operationId":"kms.keys.import-parameters","summary":"Get a wrapping public key and a single-use import token for an imported key","description":"`kms:GetParametersForImport` Get a wrapping public key and a single-use import token for an imported key. Only for a key created with origin \"external\". Returns an RSA-3072 public key (SubjectPublicKeyInfo DER, base64) and an import token, both valid 24 hours. Wrap a 32-byte AES-256 key with RSAES_OAEP_SHA_256 (RSA-OAEP, SHA-256, MGF1 SHA-256) or RSA_AES_KEY_WRAP_SHA_256 (RSA-OAEP of a fresh AES-256 key, then AES-KWP RFC 5649 of the material, concatenated).","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"wrappingAlgorithm":{"default":"RSAES_OAEP_SHA_256","type":"string","enum":["RSAES_OAEP_SHA_256","RSA_AES_KEY_WRAP_SHA_256"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:GetParametersForImport","x-ews-mutates":false,"x-ews-sensitive":false}},"/kms/api/keys/{id}/make-default":{"post":{"operationId":"kms.keys.make-default","summary":"Make a key the default: new secrets and managed databases are encrypted under it","description":"`kms:UpdateKey` Make a key the default: new secrets and managed databases are encrypted under it. Only an enabled encrypt/decrypt key (409 otherwise). With no default chosen, the oldest enabled key is the default; `default` in the key list says which one it is now.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:UpdateKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/material":{"delete":{"operationId":"kms.keys.delete-material","summary":"Delete imported key material — everything under the key is unreadable until re-imported","description":"`kms:DeleteImportedKeyMaterial` Delete imported key material — everything under the key is unreadable until re-imported. The key becomes pending_import. Secrets, volumes, databases and caches under it stop opening.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:DeleteImportedKeyMaterial","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/schedule-deletion":{"post":{"operationId":"kms.keys.schedule-deletion","summary":"Schedule a key for deletion after a waiting period","description":"`kms:ScheduleKeyDeletion` Schedule a key for deletion after a waiting period. 409 `default_key` for the default key: make another key the default first.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pendingWindowInDays":{"default":30,"type":"integer","minimum":7,"maximum":30}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ScheduleKeyDeletion","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/keys/{id}/usage":{"get":{"operationId":"kms.keys.usage","summary":"Count what the key protects: secrets, volumes by kind, databases, caches","description":"`kms:GetKey` Count what the key protects: secrets, volumes by kind, databases, caches. `notCovered` lists what customer keys do not encrypt yet (object storage among them).","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:GetKey","x-ews-mutates":false,"x-ews-sensitive":false}},"/kms/api/ssh-key-pairs":{"get":{"operationId":"kms.ssh-key-pairs.list","summary":"List SSH key pairs","description":"`kms:ListSshKeyPairs` List SSH key pairs.","tags":["KMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ListSshKeyPairs","x-ews-mutates":false,"x-ews-sensitive":false}},"/kms/api/ssh-key-pairs/{id}":{"get":{"operationId":"kms.ssh-key-pairs.get","summary":"Describe one SSH key pair","description":"`kms:GetSshKeyPair` Describe one SSH key pair.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:GetSshKeyPair","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"kms.ssh-key-pairs.delete","summary":"Delete an SSH key pair","description":"`kms:DeleteSshKeyPair` Delete an SSH key pair.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:DeleteSshKeyPair","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/ssh-key-pairs/{id}/sync":{"post":{"operationId":"kms.ssh-key-pairs.sync","summary":"Re-read a synced key pair’s public key through its source now","description":"`kms:ImportSshKeyPair` Re-read a synced key pair’s public key through its source now.","tags":["KMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ImportSshKeyPair","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:SyncSecret"]}},"/kms/api/ssh-key-pairs/from-source":{"post":{"operationId":"kms.ssh-key-pairs.import-from-source","summary":"Add a key pair whose public key comes from a password manager and follows it","description":"`kms:ImportSshKeyPair` Add a key pair whose public key comes from a password manager and follows it. `reference`: op://vault/item/public key (a 1Password SSH Key item) or vault://mount/path#public_key. Only a public key is accepted; a reference to a private key is refused. The source sync keeps it in step: a changed key replaces the stored one and is uploaded anew; instances keep the key they booted with.","tags":["KMS"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"reference":{"type":"string","minLength":1,"maxLength":512},"source":{"type":"string","minLength":2,"maxLength":63},"uploadToHetzner":{"default":true,"type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","reference"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ImportSshKeyPair","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:UseSecretSource"]}},"/kms/api/ssh-key-pairs/generate":{"post":{"operationId":"kms.ssh-key-pairs.generate","summary":"Generate a key pair and return the private key once","description":"`kms:GenerateSshKeyPair` Generate a key pair and return the private key once. The private key is in the response and is never stored or retrievable again.","tags":["KMS"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"comment":{"type":"string","maxLength":128},"uploadToHetzner":{"default":true,"type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:GenerateSshKeyPair","x-ews-mutates":true,"x-ews-sensitive":false}},"/kms/api/ssh-key-pairs/import":{"post":{"operationId":"kms.ssh-key-pairs.import","summary":"Import an existing SSH public key","description":"`kms:ImportSshKeyPair` Import an existing SSH public key.","tags":["KMS"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"publicKey":{"type":"string","minLength":1},"uploadToHetzner":{"default":true,"type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","publicKey"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"kms:ImportSshKeyPair","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers":{"get":{"operationId":"lb.load-balancers.list","summary":"List load balancers","description":"`lb:DescribeLoadBalancers` List load balancers.","tags":["Load balancing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:DescribeLoadBalancers","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"lb.load-balancers.create","summary":"Create a load balancer","description":"`lb:CreateLoadBalancer` Create a load balancer. It starts with no services and no targets: add a service (listener) and at least one target before it carries traffic. Refused (400) when an organization tag policy requires tags that are missing.","tags":["Load balancing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"Name shown in the console, 1–64 characters. Not unique: two load balancers may share one. An application load balancer’s platform name is `<name>-<id8>.lb.apps.…`"},"type":{"type":"string","enum":["lb11","lb21","lb31","application","dedicated"],"description":"Required (the console's form starts on lb11). lb11/lb21/lb31: a network load balancer of that size (tcp/http/https, VPC targets). application: an HTTP/HTTPS load balancer on the shared Deutsche Cloud fleet: its own name under lb.apps, per-request access logs, live numbers, health checks every second; http on 80 and https on 443 only, public targets only. dedicated: its own address on the Deutsche Cloud fleet, tcp/http/https on any port; public (own IPv4 + IPv6) or private (scheme private + vpcId: an address in the VPC only). In an organization whose load balancers run on its own hosts, only application is accepted (409, code provider_unsupported). Fixed at creation"},"scheme":{"description":"dedicated type only (400 on any other type): public (default; its own IPv4 and IPv6, public targets; 400 with vpcId) or private (an address in vpcId only, no public address; targets inside that VPC; 400 without vpcId; 409 when the VPC has no address left, at most 5 private load balancers per VPC). Fixed at creation","type":"string","enum":["public","private"]},"algorithm":{"default":"round_robin","description":"How new connections are spread over healthy targets: round_robin (default) sends each to the next target, least_connections to the least busy","type":"string","enum":["round_robin","least_connections"]},"regionId":{"type":"string","minLength":1,"description":"Region id, from `dcloud ec2 catalog regions`. Unknown: 404. Counts against the region’s load balancer quota (20 standard, 2 on a trial; over it: 409)"},"vpcId":{"description":"lb11/lb21/lb31: join this VPC, so targets can be reached by their private address (`usePrivateIp`). dedicated: required with scheme private, refused with public. application: refused (400). Not found: 404; in another region than regionId: 400. Default: no VPC","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tags":{"description":"Tags to set at creation, e.g. {\"env\": \"prod\"}: at most 50; keys lowercase, 1–64 characters; values 1–128 characters without spaces. Keys your organization marks required must be present, or the create is refused (400)","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"webAclId":{"description":"application type only (400 on any other type): a web ACL (`dcloud waf web-acls`) every request passes before anything else answers. Needs lb:SetWebAcl, and waf:GetWebAcl on the ACL (403); an ACL not in your organization: 404. Absent or null: none","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["name","type","regionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:CreateLoadBalancer","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}":{"get":{"operationId":"lb.load-balancers.get","summary":"One load balancer with its services and targets","description":"`lb:DescribeLoadBalancers` One load balancer with its services and targets.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:DescribeLoadBalancers","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"lb.load-balancers.update","summary":"Attach a web ACL to an application load balancer, or detach it","description":"`lb:SetWebAcl` Attach a web ACL to an application load balancer, or detach it. application type only (400 on lb11/lb21/lb31: put a CDN distribution with the ACL in front instead). Needs waf:GetWebAcl on the ACL. The fleet nodes run it within seconds, after TLS and before routing, redirects and error pages; matches are in the access log and under `dcloud waf web-acls logs`. Rate rules count exactly (one node serves at a time). No extra charge beyond the web ACL itself.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webAclId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The web ACL every request passes; null detaches it. Required (send null to detach). application type only (400). An ACL not in your organization: 404; without waf:GetWebAcl on it: 403"}},"required":["webAclId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:SetWebAcl","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"lb.load-balancers.delete","summary":"Delete a load balancer","description":"`lb:DeleteLoadBalancer` Delete a load balancer.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:DeleteLoadBalancer","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/live":{"get":{"operationId":"lb.load-balancers.live","summary":"Live numbers of an application or dedicated load balancer, from the fleet nodes","description":"`lb:DescribeLoadBalancers` Live numbers of an application or dedicated load balancer, from the fleet nodes. application and dedicated types only: per node, its counters for this load balancer (connections, requests, 429s, 421s, handshakes, statuses, bytes) and every target’s health as the node checks it, with when the node reported. The active node serves the traffic; the standby’s numbers are its own.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:DescribeLoadBalancers","x-ews-mutates":false,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/rules":{"post":{"operationId":"lb.rules.add","summary":"Add a host/path rule forwarding to a target group","description":"`lb:AddRule` Add a host/path rule forwarding to a target group. application type only (400 on lb11/lb21/lb31). Rules apply to the http and https services alike, lowest priority first; a request no rule matches goes to the `default` target group. A rule whose group has no target answers 503 and never falls through to another group (the load balancer’s `application.warnings` says so). The host must be one of the load balancer’s own names. Live within seconds; no provider work. To change a rule, remove it and add it again. The console suggests priority 10, then 10 above the highest.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"priority":{"type":"integer","minimum":1,"maximum":1000,"description":"1–1000, evaluated lowest first; unique per load balancer (a taken one is refused). At most 50 rules"},"host":{"description":"One of the load balancer’s own names (its platform name or a name of its https service). Left out: every name it answers to","type":"string","minLength":1,"maxLength":253},"pathPrefix":{"description":"Matches on path segments: /api matches /api, /api/ and /api/v1, not /apix. Left out: any path","type":"string","minLength":1,"maxLength":256,"pattern":"^\\/[^\\s?#*]*$"},"targetGroup":{"type":"string","pattern":"^[a-z0-9]([a-z0-9-]{0,30}[a-z0-9])?$","description":"The target group that serves matching requests"}},"required":["priority","targetGroup"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:AddRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/rules/{ruleId}":{"delete":{"operationId":"lb.rules.remove","summary":"Remove a rule","description":"`lb:RemoveRule` Remove a rule.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Rule id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:RemoveRule","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/services":{"post":{"operationId":"lb.services.add","summary":"Add a service (listener)","description":"`lb:AddService` Add a service (listener). An https service terminates TLS and needs a certificate: either `domains` (Deutsche Cloud issues it over DNS-01, so every name must be in one of your hosted zones; the service is created at the provider once it is issued, about a minute, and `certificateStatus` goes pending → active) or `certificatePem` + `privateKeyPem` (attached at once). A name outside your hosted zones is refused (400): the certificate authority cannot check it over HTTP, because port 80 goes to your targets.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protocol":{"type":"string","enum":["tcp","http","https"],"description":"What the load balancer speaks on sourcePort. https terminates TLS and needs a certificate (domains, or certificatePem + privateKeyPem), except on an application load balancer, whose platform name is served by the fleet’s own certificate when neither is given. tcp is refused (400) on application load balancers"},"sourcePort":{"type":"integer","minimum":1,"maximum":65535,"description":"Port the load balancer listens on, 1–65535; one service per port (400 when taken, and port 80 is taken by an https service that redirects). application: http on 80 and https on 443 only (400). dedicated: not 22, 9901 or 9902 (400), at most 10 services. The console’s form starts on 80 (443 for https)"},"destinationPort":{"type":"integer","minimum":1,"maximum":65535,"description":"Port on the targets traffic is sent to, 1–65535. The console’s form starts on 80"},"proxyprotocol":{"description":"Prepend the PROXY protocol header to each connection to a target. Default false. Refused (400) on application load balancers, whose targets get X-Forwarded-For and X-Real-IP instead","type":"boolean"},"healthCheckPath":{"description":"HTTP path probed for health when healthCheckProtocol is http (default `/`). Not checked here; `services update` requires a leading / and at most 256 characters","type":"string"},"domains":{"description":"https only (400 otherwise): names for a certificate Deutsche Cloud issues and renews over DNS-01, at most 50, each up to 253 characters; lower-cased and de-duplicated. Every name (wildcards allowed) must be in one of your Deutsche Cloud hosted zones (400). Not together with certificatePem (400). application: at most 10 names including its platform name, and none another load balancer on the fleet already serves (400)","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":253}},"certificatePem":{"description":"https only, instead of domains: your certificate in PEM, leaf first, then the chain; at most 64 KiB. Must parse and match privateKeyPem (400). Never renewed by the platform","type":"string","maxLength":65536},"privateKeyPem":{"description":"https, with certificatePem (400 with one but not the other): its unencrypted private key in PEM, at most 16 KiB. lb11/lb21/lb31: handed to the provider and not stored by Deutsche Cloud. application and dedicated: stored sealed under the KMS master key, opened only to configure the fleet","type":"string","maxLength":16384},"redirectHttp":{"description":"https only: answer port 80 with a 301 redirect to https. Port 80 must be free and the service may not itself listen on 80 (400). Default false in the API; the console’s form ticks it","type":"boolean"},"healthCheckProtocol":{"description":"http (default): GET the health-check path, 2xx/3xx is healthy. tcp: a connection is enough","type":"string","enum":["http","tcp"]},"healthCheckInterval":{"description":"Seconds between health checks (default 15): 3–60 on lb11/lb21/lb31 (400 below 3), 1–60 on application and dedicated load balancers","type":"integer","minimum":1,"maximum":60},"healthCheckTimeout":{"description":"Seconds a health check may take, 1–60 and at most the interval (400 above it; default 10)","type":"integer","minimum":1,"maximum":60},"healthCheckRetries":{"description":"Failed checks in a row before a target stops taking traffic (0–5, default 3). A dead target keeps traffic for about interval × (retries + 1)","type":"integer","minimum":0,"maximum":5},"stickySessions":{"description":"http/https: pin each client to one target with a cookie the load balancer sets (default false; refused with 400 on a tcp service)","type":"boolean"},"stickyCookieName":{"description":"Name of the sticky-session cookie (default EWSLB)","type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"},"stickyCookieLifetime":{"description":"Seconds the sticky-session cookie lasts (60 s – 7 days, default 300)","type":"integer","minimum":60,"maximum":604800},"healthCheckPort":{"description":"dedicated type only (400 on the others): the port the health check asks, 1–65535 (default: the target port), e.g. an HTTP health endpoint next to a tcp service","type":"integer","minimum":1,"maximum":65535},"closeOnUnhealthy":{"description":"dedicated tcp only (400 on the other types and protocols): close open connections to a target whose health check answers no (an HTTP status outside 2xx/3xx, retries times in a row); a check that only times out closes nothing. For a database primary endpoint. Default false","type":"boolean"}},"required":["protocol","sourcePort","destinationPort"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:AddService","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/services/{serviceId}":{"patch":{"operationId":"lb.services.update","summary":"Change a service’s health check or sticky sessions","description":"`lb:UpdateService` Change a service’s health check or sticky sessions. Only the fields sent change; the rules across fields are checked against the service as it then is. healthCheckTimeout may not exceed healthCheckInterval, an interval under 3 s is refused on lb11/lb21/lb31, and sticky sessions are refused (400) on a tcp service. The change reaches the load balancer within seconds; an https service still waiting for its certificate gets it when the certificate is served.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}},{"name":"serviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Service id (uuid)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"healthCheckProtocol":{"description":"http (default): GET the health-check path, 2xx/3xx is healthy. tcp: a connection is enough","type":"string","enum":["http","tcp"]},"healthCheckPath":{"description":"HTTP path probed for health when healthCheckProtocol is http: starts with /, at most 256 characters (default /)","type":"string","minLength":1,"maxLength":256,"pattern":"^\\/"},"healthCheckInterval":{"description":"Seconds between health checks (default 15): 3–60 on lb11/lb21/lb31 (400 below 3), 1–60 on application and dedicated load balancers","type":"integer","minimum":1,"maximum":60},"healthCheckTimeout":{"description":"Seconds a health check may take, 1–60 and at most the interval (400 above it; default 10)","type":"integer","minimum":1,"maximum":60},"healthCheckRetries":{"description":"Failed checks in a row before a target stops taking traffic (0–5, default 3). A dead target keeps traffic for about interval × (retries + 1)","type":"integer","minimum":0,"maximum":5},"stickySessions":{"description":"http/https: pin each client to one target with a cookie the load balancer sets (default false; refused with 400 on a tcp service)","type":"boolean"},"stickyCookieName":{"description":"Name of the sticky-session cookie (default EWSLB)","type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"},"stickyCookieLifetime":{"description":"Seconds the sticky-session cookie lasts (60 s – 7 days, default 300)","type":"integer","minimum":60,"maximum":604800}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:UpdateService","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"lb.services.delete","summary":"Delete a service (listener)","description":"`lb:DeleteService` Delete a service (listener).","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}},{"name":"serviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Service id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:DeleteService","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/services/{serviceId}/renew-certificate":{"post":{"operationId":"lb.services.renew-certificate","summary":"Issue the https certificate for the service’s domains again now","description":"`lb:UpdateService` Issue the https certificate for the service’s domains again now. For a certificate Deutsche Cloud issues (one added with `domains`): retries a failed one, or renews early. Renewal is otherwise automatic, under 30 days before expiry. Refused (400) for an uploaded certificate.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}},{"name":"serviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Service id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:UpdateService","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/targets":{"post":{"operationId":"lb.targets.add","summary":"Add an instance or IP address as a target","description":"`lb:AddTarget` Add an instance or IP address as a target.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["server","ip"],"description":"`server` for a Deutsche Cloud instance, `ip` for an address"},"instanceId":{"description":"Instance id (i-…). Required when type is server (400 without). The instance must be in your organization (400 \"Instance not found\") and in the load balancer’s region (400). application and public dedicated: it needs a public IPv4 (400); private dedicated: it must be in the load balancer’s VPC and have an address there (400)","type":"string","pattern":"^i-[0-9a-f]{6,32}$"},"ip":{"description":"IPv4 address. Required when type is ip (400 without). application and public dedicated: a public address that is not the platform’s own (400); private dedicated: inside the VPC’s CIDR (400)","type":"string"},"usePrivateIp":{"description":"lb11/lb21/lb31, server targets: reach the instance over its private network address. Needs a load balancer created with vpcId (400). Refused (400) on application; ignored on dedicated, where the scheme decides (private: VPC address, public: public address). Default false","type":"boolean"},"targetGroup":{"description":"application load balancers: the target group this target serves (lower-case letters, digits and -, 1–32). Rules forward to a group; requests no rule matches go to `default`. Default `default`; any other value is refused (400) on the other types. At most 10 groups and 25 targets per application load balancer (400)","type":"string","pattern":"^[a-z0-9]([a-z0-9-]{0,30}[a-z0-9])?$"}},"required":["type"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:AddTarget","x-ews-mutates":true,"x-ews-sensitive":false}},"/lb/api/load-balancers/{id}/targets/{targetId}":{"delete":{"operationId":"lb.targets.remove","summary":"Remove a target","description":"`lb:RemoveTarget` Remove a target.","tags":["Load balancing"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Load balancer id (uuid). Not a uuid, or not in your organization: 404"}},{"name":"targetId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Target id (uuid)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"lb:RemoveTarget","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/alarms":{"get":{"operationId":"monitoring.alarms.list","summary":"List alarms, those in ALARM first","description":"`monitoring:DescribeAlarms` List alarms, those in ALARM first.","tags":["Monitoring"],"parameters":[{"name":"resourceType","in":"query","required":false,"schema":{"type":"string","enum":["instance","db_node","vpn_connection","eks_cluster","app"]}},{"name":"resourceId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeAlarms","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"monitoring.alarms.create","summary":"Create an alarm on one metric of one resource","description":"`monitoring:PutMetricAlarm` Create an alarm on one metric of one resource. An alarm goes to ALARM when every one of its evaluation periods breaches, to OK when any does not, and to INSUFFICIENT_DATA when none has data. webhookUrl must be https on a public address. Notifications go out on entering and leaving ALARM.","tags":["Monitoring"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceType":{"type":"string","enum":["instance","db_node","vpn_connection","eks_cluster","app","custom"],"description":"custom: a series the organization publishes itself"},"resourceId":{"type":"string","description":"The instance, database node or site-to-site connection id; for custom, the series’ namespace"},"metric":{"type":"string","description":"One of cpu_percent, disk_read_iops, disk_write_iops, disk_read_bps, disk_write_bps, network_in_bps, network_out_bps, disk_used_percent, connections, replication_lag_bytes, query_slowdown, docdb_up, tunnel_up, tunnel_in_bps, tunnel_out_bps, bgp_prefixes, api_available, control_plane_ready, nodes_ready, nodes_not_ready, cdn_requests, cdn_cache_hits, cdn_cache_misses, cdn_hit_ratio, cdn_bytes_out, cdn_origin_bytes, waf_blocked, waf_counted, waf_challenged, waf_rate_limited, deploy_duration_seconds, deploys_succeeded, deploys_failed; for custom, the series’ metric name"},"dimensions":{"description":"custom only: the series’ dimensions","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Up to 10 name → value pairs; together with namespace and name they make the series"},{"type":"null"}]},"statistic":{"type":"string","enum":["avg","max","min","sum","count"],"description":"count is the number of samples (CloudWatch SampleCount)"},"comparator":{"type":"string","enum":[">",">=","<","<="]},"threshold":{"type":"number"},"periodSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"evaluationPeriods":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notifyEmails":{"type":"array","items":{"type":"string"}},"webhookUrl":{"type":["string","null"]},"enabled":{"type":"boolean"}},"required":["name","resourceType","resourceId","metric","comparator","threshold","periodSeconds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:PutMetricAlarm","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/alarms/{id}":{"get":{"operationId":"monitoring.alarms.get","summary":"Describe one alarm and its current state","description":"`monitoring:DescribeAlarms` Describe one alarm and its current state.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeAlarms","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"monitoring.alarms.update","summary":"Change an alarm; changing what it measures resets it to INSUFFICIENT_DATA","description":"`monitoring:PutMetricAlarm` Change an alarm; changing what it measures resets it to INSUFFICIENT_DATA.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"resourceType":{"type":"string","enum":["instance","db_node","vpn_connection","eks_cluster","app","custom"],"description":"custom: a series the organization publishes itself"},"resourceId":{"type":"string","description":"The instance, database node or site-to-site connection id; for custom, the series’ namespace"},"metric":{"type":"string","description":"One of cpu_percent, disk_read_iops, disk_write_iops, disk_read_bps, disk_write_bps, network_in_bps, network_out_bps, disk_used_percent, connections, replication_lag_bytes, query_slowdown, docdb_up, tunnel_up, tunnel_in_bps, tunnel_out_bps, bgp_prefixes, api_available, control_plane_ready, nodes_ready, nodes_not_ready, cdn_requests, cdn_cache_hits, cdn_cache_misses, cdn_hit_ratio, cdn_bytes_out, cdn_origin_bytes, waf_blocked, waf_counted, waf_challenged, waf_rate_limited, deploy_duration_seconds, deploys_succeeded, deploys_failed; for custom, the series’ metric name"},"dimensions":{"description":"custom only: the series’ dimensions","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Up to 10 name → value pairs; together with namespace and name they make the series"},{"type":"null"}]},"statistic":{"type":"string","enum":["avg","max","min","sum","count"],"description":"count is the number of samples (CloudWatch SampleCount)"},"comparator":{"type":"string","enum":[">",">=","<","<="]},"threshold":{"type":"number"},"periodSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"evaluationPeriods":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notifyEmails":{"type":"array","items":{"type":"string"}},"webhookUrl":{"type":["string","null"]},"enabled":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:PutMetricAlarm","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"monitoring.alarms.delete","summary":"Delete an alarm and its history","description":"`monitoring:DeleteAlarms` Delete an alarm and its history.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DeleteAlarms","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/alarms/{id}/history":{"get":{"operationId":"monitoring.alarms.history","summary":"The state changes of an alarm, newest first, and who was notified","description":"`monitoring:DescribeAlarmHistory` The state changes of an alarm, newest first, and who was notified.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeAlarmHistory","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/checks":{"get":{"operationId":"monitoring.checks.list","summary":"List uptime checks, those that are down first","description":"`monitoring:DescribeChecks` List uptime checks, those that are down first.","tags":["Monitoring"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeChecks","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"monitoring.checks.create","summary":"Create an uptime check","description":"`monitoring:CreateCheck` Create an uptime check. The check runs within a minute, then every intervalSeconds. A failed run is retried once after 3 s; failureThreshold failed runs in a row make it DOWN, two successful runs make it UP again, and both are mailed to notifyEmails and POSTed to webhookUrl. Unconfirmed runs are repeated after a minute. At most 50 checks per organization, and at most 6 requests a minute to one host across every check on Deutsche Cloud.","tags":["Monitoring"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique in the organization, up to 128 characters"},"type":{"type":"string","enum":["http","keyword"],"description":"http: the status decides; keyword: the body must (not) contain a text too"},"url":{"type":"string","description":"http:// or https:// on a public address; any port except 25, 465 and 587"},"method":{"description":"GET by default; keyword checks use GET","type":"string","enum":["GET","HEAD"]},"expectedStatusMin":{"description":"Lowest status that counts as up (default 200)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatusMax":{"description":"Highest status that counts as up (default 399)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keyword":{"description":"For keyword checks: the text looked for in the first 1 MiB","type":["string","null"]},"keywordMode":{"description":"contains (default) or not_contains","anyOf":[{"type":"string","enum":["contains","not_contains"]},{"type":"null"}]},"timeoutMs":{"description":"1000–30000, default 10000","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"intervalSeconds":{"description":"60, 120, 300 (default), 600, 900, 1800 or 3600","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followRedirects":{"description":"Follow up to 5 redirects, each re-checked (default true)","type":"boolean"},"verifyTls":{"description":"Fail on an invalid certificate (default true)","type":"boolean"},"failureThreshold":{"description":"Failed runs in a row before DOWN, 1–5 (default 2)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"confirmations":{"description":"Locations that must fail in one run for it to count as failed, 1–3 (default 2); fewer failing is \"regional\"","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"alertOnRegional":{"description":"Treat one failing location as failed, as if confirmations were 1 (default false)","type":"boolean"},"notifyEmails":{"description":"Up to 10 addresses mailed on DOWN and on UP again","type":"array","items":{"type":"string"}},"webhookUrl":{"description":"https URL on a public address, POSTed on DOWN and UP","type":["string","null"]}},"required":["name","url"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:CreateCheck","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/checks/{id}":{"get":{"operationId":"monitoring.checks.get","summary":"Describe one uptime check: its settings, state and why, and its last result","description":"`monitoring:DescribeChecks` Describe one uptime check: its settings, state and why, and its last result.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeChecks","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"monitoring.checks.update","summary":"Change an uptime check; changing what it requests starts it over as pending","description":"`monitoring:UpdateCheck` Change an uptime check; changing what it requests starts it over as pending.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique in the organization, up to 128 characters"},"type":{"type":"string","enum":["http","keyword"],"description":"http: the status decides; keyword: the body must (not) contain a text too"},"url":{"type":"string","description":"http:// or https:// on a public address; any port except 25, 465 and 587"},"method":{"description":"GET by default; keyword checks use GET","type":"string","enum":["GET","HEAD"]},"expectedStatusMin":{"description":"Lowest status that counts as up (default 200)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expectedStatusMax":{"description":"Highest status that counts as up (default 399)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keyword":{"description":"For keyword checks: the text looked for in the first 1 MiB","type":["string","null"]},"keywordMode":{"description":"contains (default) or not_contains","anyOf":[{"type":"string","enum":["contains","not_contains"]},{"type":"null"}]},"timeoutMs":{"description":"1000–30000, default 10000","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"intervalSeconds":{"description":"60, 120, 300 (default), 600, 900, 1800 or 3600","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followRedirects":{"description":"Follow up to 5 redirects, each re-checked (default true)","type":"boolean"},"verifyTls":{"description":"Fail on an invalid certificate (default true)","type":"boolean"},"failureThreshold":{"description":"Failed runs in a row before DOWN, 1–5 (default 2)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"confirmations":{"description":"Locations that must fail in one run for it to count as failed, 1–3 (default 2); fewer failing is \"regional\"","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"alertOnRegional":{"description":"Treat one failing location as failed, as if confirmations were 1 (default false)","type":"boolean"},"notifyEmails":{"description":"Up to 10 addresses mailed on DOWN and on UP again","type":"array","items":{"type":"string"}},"webhookUrl":{"description":"https URL on a public address, POSTed on DOWN and UP","type":["string","null"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateCheck","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"monitoring.checks.delete","summary":"Delete an uptime check with its results and outages","description":"`monitoring:DeleteChecks` Delete an uptime check with its results and outages.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DeleteChecks","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/checks/{id}/outages":{"get":{"operationId":"monitoring.checks.outages","summary":"The outage log of a check, newest first, with who was notified","description":"`monitoring:GetCheckResults` The outage log of a check, newest first, with who was notified.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"1–500, default 50","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:GetCheckResults","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/checks/{id}/pause":{"post":{"operationId":"monitoring.checks.pause","summary":"Stop running a check; an open outage is closed without a notification","description":"`monitoring:PauseChecks` Stop running a check; an open outage is closed without a notification.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:PauseChecks","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/checks/{id}/results":{"get":{"operationId":"monitoring.checks.results","summary":"Uptime %, response times per period, and the latest raw results of a check","description":"`monitoring:GetCheckResults` Uptime %, response times per period, and the latest raw results of a check. At most 30 days at once; raw results are kept 30 days. uptimePercent is the share of the window not covered by an outage. series has about 300 points whatever the range.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"start","in":"query","required":false,"schema":{"description":"ISO 8601; defaults to a day before end","type":"string"}},{"name":"end","in":"query","required":false,"schema":{"description":"ISO 8601; defaults to now","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"description":"Raw results to return, newest first, 0–500 (default 50)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:GetCheckResults","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/checks/{id}/resume":{"post":{"operationId":"monitoring.checks.resume","summary":"Run a paused check again, from pending","description":"`monitoring:ResumeChecks` Run a paused check again, from pending.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:ResumeChecks","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/custom-metrics":{"post":{"operationId":"monitoring.custom-metrics.put","summary":"Publish datapoints to custom metrics (CloudWatch PutMetricData)","description":"`monitoring:PutMetricData` Publish datapoints to custom metrics (CloudWatch PutMetricData). Datums are checked one by one: the valid ones are stored and each refused one is listed with its index and reason (400 only when none was stored). Values are aggregated per minute. At most 1000 active series per organization and 20000 datums a minute. Kept 15 days per minute, 15 months per hour. OTLP/HTTP (JSON) is accepted at /monitoring/api/otlp/v1/metrics.","tags":["Monitoring"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"namespace":{"type":"string","description":"Letters, digits and . _ / # : -, up to 255; EWS/ and AWS/ are reserved"},"metricData":{"type":"array","items":{"type":"object","properties":{"metricName":{"type":"string","description":"Up to 255 characters"},"dimensions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Up to 10 name → value pairs; together with namespace and name they make the series"},"timestamp":{"description":"ISO 8601 or epoch milliseconds; now when left out. At most 14 days old, 2 h ahead","anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"unit":{"description":"Free text, e.g. Seconds, Bytes, Count; shown, not converted","type":"string"},"value":{"description":"One value. Exactly one of value, values, statistics","type":"number"},"values":{"description":"Up to 150 values at once","type":"array","items":{"type":"number"}},"counts":{"description":"How often each of values occurred","type":"array","items":{"type":"number"}},"statistics":{"description":"A pre-aggregated set","type":"object","properties":{"count":{"type":"number"},"sum":{"type":"number"},"min":{"type":"number"},"max":{"type":"number"}},"required":["count","sum","min","max"]}},"required":["metricName"]},"description":"1–1000 datums"}},"required":["namespace","metricData"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:PutMetricData","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"monitoring.custom-metrics.list","summary":"List custom series: namespace, metric name, dimensions, last datapoint","description":"`monitoring:ListMetrics` List custom series: namespace, metric name, dimensions, last datapoint.","tags":["Monitoring"],"parameters":[{"name":"namespace","in":"query","required":false,"schema":{"description":"Only this namespace","type":"string"}},{"name":"name","in":"query","required":false,"schema":{"description":"Case-insensitive substring of the metric name","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"description":"1–1000, default 200","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:ListMetrics","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/custom-metrics/data":{"get":{"operationId":"monitoring.custom-metrics.get-data","summary":"Datapoints of one custom series, one per period","description":"`monitoring:GetMetricData` Datapoints of one custom series, one per period. Ranges older than 15 days, or periods of whole hours, are read from hourly rows and the period is rounded up to an hour.","tags":["Monitoring"],"parameters":[{"name":"seriesId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"From custom-metrics list"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","description":"ISO 8601"}},{"name":"end","in":"query","required":false,"schema":{"description":"ISO 8601; now when left out","type":"string"}},{"name":"period","in":"query","required":false,"schema":{"description":"Seconds, a whole number of minutes, default 60; at most 1440 points","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"name":"statistic","in":"query","required":false,"schema":{"description":"avg (default), sum, min, max or count","type":"string","enum":["avg","max","min","sum","count"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:GetMetricData","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/locations":{"get":{"operationId":"monitoring.checks.locations","summary":"Where checks run from: the control plane and each probe location, its health and the addresses to allowlist","description":"`monitoring:DescribeChecks` Where checks run from: the control plane and each probe location, its health and the addresses to allowlist. Every run asks every healthy location at once; a run fails only when `confirmations` locations fail. The control plane does not check Deutsche Cloud’s own addresses.","tags":["Monitoring"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeChecks","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/logs":{"get":{"operationId":"monitoring.logs.filter","summary":"Search an app’s log lines, newest first","description":"`monitoring:FilterLogEvents` Search an app’s log lines, newest first. start defaults to a day before end, end to now. contains is a case-insensitive substring. limit is at most 1000. Logs are kept 7 days.","tags":["Monitoring"],"parameters":[{"name":"resourceType","in":"query","required":false,"schema":{"type":"string","enum":["app","schedule","function"]}},{"name":"resourceId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"contains","in":"query","required":false,"schema":{"type":"string"}},{"name":"stream","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:FilterLogEvents","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/metrics":{"get":{"operationId":"monitoring.metrics.list","summary":"List the metrics of one resource and when each was last recorded","description":"`monitoring:ListMetrics` List the metrics of one resource and when each was last recorded.","tags":["Monitoring"],"parameters":[{"name":"resourceType","in":"query","required":true,"schema":{"type":"string","enum":["instance","db_node","vpn_connection","eks_cluster","app"]}},{"name":"resourceId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:ListMetrics","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/metrics/data":{"get":{"operationId":"monitoring.metrics.get-data","summary":"Datapoints of up to eight metrics of one resource, one per period","description":"`monitoring:GetMetricData` Datapoints of up to eight metrics of one resource, one per period. metrics is comma-separated. start and end are ISO 8601; end defaults to now. period is seconds, a whole number of minutes; at most 1440 points per series. Metrics are kept 14 days.","tags":["Monitoring"],"parameters":[{"name":"resourceType","in":"query","required":true,"schema":{"type":"string","enum":["instance","db_node","vpn_connection","eks_cluster","app"]}},{"name":"resourceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"period","in":"query","required":false,"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"name":"statistic","in":"query","required":false,"schema":{"type":"string","enum":["avg","max","min"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:GetMetricData","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/resources":{"get":{"operationId":"monitoring.metrics.resources","summary":"List the resources that record metrics, and the apps that ship logs","description":"`monitoring:ListMetrics` List the resources that record metrics, and the apps that ship logs.","tags":["Monitoring"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:ListMetrics","x-ews-mutates":false,"x-ews-sensitive":false}},"/monitoring/api/status-pages":{"get":{"operationId":"monitoring.status-pages.list","summary":"List the organization’s status pages and their public URLs","description":"`monitoring:DescribeStatusPages` List the organization’s status pages and their public URLs.","tags":["Monitoring"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeStatusPages","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"monitoring.status-pages.create","summary":"Publish a status page at {slug}.status.{root}","description":"`monitoring:CreateStatusPage` Publish a status page at {slug}.status.{root}. The slug is the host label, unique across Deutsche Cloud; a few words (ews, www, status, api, …) are reserved. At most 5 pages per organization. The page is public at once; add components with put-components.","tags":["Monitoring"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"The host label: {slug}.status.{root}. 3–63 lower-case letters, digits, dashes"},"title":{"type":"string","description":"Shown at the top of the page, up to 120 characters"},"description":{"description":"Plain text under the title","type":["string","null"]}},"required":["slug","title"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:CreateStatusPage","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}":{"get":{"operationId":"monitoring.status-pages.get","summary":"Describe a status page: its components, their current state, subscriber count","description":"`monitoring:DescribeStatusPages` Describe a status page: its components, their current state, subscriber count.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeStatusPages","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"monitoring.status-pages.update","summary":"Change a status page’s title, description or address","description":"`monitoring:UpdateStatusPage` Change a status page’s title, description or address.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"The host label: {slug}.status.{root}. 3–63 lower-case letters, digits, dashes"},"title":{"type":"string","description":"Shown at the top of the page, up to 120 characters"},"description":{"description":"Plain text under the title","type":["string","null"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateStatusPage","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"monitoring.status-pages.delete","summary":"Delete a status page, its incidents and its subscribers","description":"`monitoring:DeleteStatusPage` Delete a status page, its incidents and its subscribers.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DeleteStatusPage","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/components":{"put":{"operationId":"monitoring.status-pages.put-components","summary":"Replace the page’s components with this ordered list","description":"`monitoring:UpdateStatusPage` Replace the page’s components with this ordered list. Each component follows an uptime check (checkId: up → operational, regional → degraded, down → major outage) or has a state set by hand (manualState). Pass a component’s id to keep it; components left out are removed. At most 50.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"components":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"What the page calls the component, up to 120 characters"},"description":{"type":["string","null"]},"groupName":{"description":"Components with one group are shown together","type":["string","null"]},"checkId":{"description":"The uptime check it follows","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"manualState":{"description":"Without a check: its state","anyOf":[{"type":"string","enum":["operational","degraded","partial_outage","major_outage"]},{"type":"null"}]},"id":{"description":"An existing component’s id, to keep it","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["name"]},"description":"The whole ordered list, at most 50"}},"required":["components"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateStatusPage","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/incidents":{"get":{"operationId":"monitoring.incidents.list","summary":"Open incidents, and those resolved in the last `days` days, newest first","description":"`monitoring:DescribeStatusPages` Open incidents, and those resolved in the last `days` days, newest first.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"description":"1–365, default 30","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeStatusPages","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"monitoring.incidents.create","summary":"Post an incident; the page’s confirmed subscribers are emailed and webhooks called","description":"`monitoring:CreateIncident` Post an incident; the page’s confirmed subscribers are emailed and webhooks called. While open, an incident makes its components at least as bad as its impact says (minor → degraded, major → partial outage, critical → major outage). Bodies are plain text.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"impact":{"type":"string","enum":["none","minor","major","critical"],"description":"none, minor (degraded), major (partial outage), critical (major outage)"},"status":{"description":"investigating by default","type":"string","enum":["investigating","identified","monitoring","resolved"]},"body":{"type":"string","description":"The first update, plain text"},"componentIds":{"description":"Components it affects","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["title","impact","body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:CreateIncident","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/incidents/{incidentId}":{"delete":{"operationId":"monitoring.incidents.delete","summary":"Remove an incident and its updates from the page (nobody is told)","description":"`monitoring:DeleteIncident` Remove an incident and its updates from the page (nobody is told).","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"incidentId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DeleteIncident","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/incidents/{incidentId}/updates":{"post":{"operationId":"monitoring.incidents.update","summary":"Post an update to an incident; status resolved closes it. Subscribers are told","description":"`monitoring:UpdateIncident` Post an update to an incident; status resolved closes it. Subscribers are told.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"incidentId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["investigating","identified","monitoring","resolved"]},"body":{"type":"string","description":"Plain text"},"impact":{"type":"string","enum":["none","minor","major","critical"],"description":"none, minor (degraded), major (partial outage), critical (major outage)"}},"required":["status","body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateIncident","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/subscribers":{"get":{"operationId":"monitoring.subscribers.list","summary":"List a page’s subscribers and whether each has confirmed","description":"`monitoring:DescribeStatusPages` List a page’s subscribers and whether each has confirmed.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:DescribeStatusPages","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"monitoring.subscribers.add","summary":"Add a webhook, or invite an email address (it confirms by link first)","description":"`monitoring:UpdateStatusPage` Add a webhook, or invite an email address (it confirms by link first). A webhook gets a JSON POST (type ews.monitoring.status-page.incident.created|updated|resolved, component.down|up). An email address gets nothing until it opens the confirmation link. At most 1000 per page.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["email","webhook"]},"target":{"type":"string","description":"An email address, or an https URL on a public address"}},"required":["kind","target"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateStatusPage","x-ews-mutates":true,"x-ews-sensitive":false}},"/monitoring/api/status-pages/{id}/subscribers/{subscriberId}":{"delete":{"operationId":"monitoring.subscribers.remove","summary":"Remove a subscriber","description":"`monitoring:UpdateStatusPage` Remove a subscriber.","tags":["Monitoring"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"subscriberId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"monitoring:UpdateStatusPage","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/ca-bundle":{"get":{"operationId":"mysql.clusters.ca-bundle","summary":"The platform CA (PEM) the clusters’ certificates chain to","description":"`mysql:DescribeMysqlClusters` The platform CA (PEM) the clusters’ certificates chain to.","tags":["MySQL"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/mysql/api/clusters":{"get":{"operationId":"mysql.clusters.list","summary":"List MySQL clusters","description":"`mysql:DescribeMysqlClusters` List MySQL clusters.","tags":["MySQL"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlClusters","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"mysql.clusters.create","summary":"Create a MySQL cluster","description":"`mysql:CreateMysqlCluster` Create a MySQL cluster. Private: without vpcId it joins the default VPC, where deployed apps run. `creating` until every node is ONLINE in one group, usually 3–5 minutes. The admin password is filed in Secrets as MYSQL_<IDENTIFIER>_PASSWORD. Every table needs a primary key (sql_require_primary_key).","tags":["MySQL"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from node-types, e.g. performance-2. The provider’s own type names are still accepted, deprecated."},"nodes":{"default":1,"description":"1: one machine. 3: a Group Replication group across zones behind a private balancer, with automatic failover","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"databaseName":{"default":"app","description":"The database created at first boot","type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"volumeSizeGib":{"default":20,"description":"Each node’s data volume (snapshots are staged on it, so leave room for a copy)","type":"integer","minimum":10,"maximum":10000},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tls":{"default":true,"description":"Clients must use TLS (platform CA). Node-to-node traffic is TLS either way","type":"boolean"},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"snapshotId":{"description":"Make the cluster from this snapshot; needs mysql:CreateMysqlCluster on the snapshot","type":"string","pattern":"^ems-[0-9a-f]{12}$"},"pointInTime":{"description":"Make the cluster from another as it was at `time` (to the second, within its restore window); needs mysql:CreateMysqlCluster on that cluster. Not with snapshotId","type":"object","properties":{"clusterId":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"},"time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["clusterId","time"]},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["identifier","nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:CreateMysqlCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}":{"get":{"operationId":"mysql.clusters.get","summary":"One cluster with its nodes: role, group member state, lag, connections, queries/s, disk","description":"`mysql:DescribeMysqlClusters` One cluster with its nodes: role, group member state, lag, connections, queries/s, disk.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlClusters","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"mysql.clusters.modify","summary":"Grow a cluster from 1 to 3 nodes in place, or shrink it from 3 to 1","description":"`mysql:ModifyMysqlCluster` Grow a cluster from 1 to 3 nodes in place, or shrink it from 3 to 1. Answers 202 and works in the background (status `modifying`; Activity shows each step). Growing: two nodes join the running group by clone while node 0 serves, then the cluster address moves to a balancer (new connections refused for some seconds). Shrinking: node 0 becomes the primary, the others leave the group one at a time and are deleted with their volumes, then the address moves back to node 0. Asking again for the same count while `modifying` resumes a stopped change.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodes":{"anyOf":[{"type":"number","const":1},{"type":"number","const":3}],"description":"The node count to go to: 3 (grow) or 1 (shrink)"}},"required":["nodes"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:ModifyMysqlCluster","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"mysql.clusters.delete","summary":"Delete a cluster, its machines, volumes, balancer and password","description":"`mysql:DeleteMysqlCluster` Delete a cluster, its machines, volumes, balancer and password. Its daily snapshots go with it; manual ones stay. With finalSnapshot=true a snapshot is taken first and kept until you delete it (counted as a manual snapshot); if it fails, nothing is deleted and the cluster is available again.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}},{"name":"finalSnapshot","in":"query","required":false,"schema":{"description":"true: take a snapshot first and keep it until you delete it; if it fails, nothing is deleted","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DeleteMysqlCluster","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}/events":{"get":{"operationId":"mysql.clusters.events","summary":"Activity: provisioning, group changes and failovers, what the nodes reported","description":"`mysql:DescribeMysqlClusters` Activity: provisioning, group changes and failovers, what the nodes reported.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}/password/rotate":{"post":{"operationId":"mysql.clusters.rotate-password","summary":"Replace the admin password with a new Secrets version","description":"`mysql:RotateMysqlPassword` Replace the admin password with a new Secrets version. The primary takes it within 30 seconds (ALTER USER … RETAIN CURRENT PASSWORD); the previous password keeps working for an hour, then is discarded.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:RotateMysqlPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}/reboot":{"post":{"operationId":"mysql.clusters.reboot","summary":"Restart one node, the primary unless nodeId names another; a primary hands its role to a secondary first","description":"`mysql:RebootMysqlNode` Restart one node, the primary unless nodeId names another; a primary hands its role to a secondary first.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","pattern":"^ewm-[0-9a-f]{12}-[0-2]$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:RebootMysqlNode","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}/restore-window":{"get":{"operationId":"mysql.clusters.restore-window","summary":"The seconds a cluster can be restored to (point in time), and its stored binary logs","description":"`mysql:DescribeMysqlSnapshots` The seconds a cluster can be restored to (point in time), and its stored binary logs. Each range runs from a snapshot to as far as the uploaded binary logs reach without a gap; the latest point is the end of the last uploaded log (the primary closes one every 5 minutes when there were writes), not now.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlSnapshots","x-ews-mutates":false,"x-ews-sensitive":false}},"/mysql/api/clusters/{id}/snapshots":{"post":{"operationId":"mysql.clusters.snapshot","summary":"Take a snapshot now (a secondary takes it when there is one)","description":"`mysql:CreateMysqlSnapshot` Take a snapshot now (a secondary takes it when there is one). Answers 202 with the snapshot `pending`; a node takes it at its next report (within 30 s) and it is `available` once uploaded.","tags":["MySQL"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:CreateMysqlSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/mysql/api/node-types":{"get":{"operationId":"mysql.clusters.node-types","summary":"The machine types a node can run on, with price and stock","description":"`mysql:DescribeMysqlClusters` The machine types a node can run on, with price and stock.","tags":["MySQL"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlClusters","x-ews-mutates":false,"x-ews-sensitive":false}},"/mysql/api/snapshots":{"get":{"operationId":"mysql.snapshots.list","summary":"List snapshots, optionally of one cluster","description":"`mysql:DescribeMysqlSnapshots` List snapshots, optionally of one cluster.","tags":["MySQL"],"parameters":[{"name":"clusterId","in":"query","required":false,"schema":{"type":"string","pattern":"^ewm-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlSnapshots","x-ews-mutates":false,"x-ews-sensitive":false}},"/mysql/api/snapshots/{snapshotId}":{"get":{"operationId":"mysql.snapshots.get","summary":"One snapshot: state, size, SHA-256","description":"`mysql:DescribeMysqlSnapshots` One snapshot: state, size, SHA-256.","tags":["MySQL"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^ems-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DescribeMysqlSnapshots","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"mysql.snapshots.delete","summary":"Delete a snapshot and its stored copy","description":"`mysql:DeleteMysqlSnapshot` Delete a snapshot and its stored copy.","tags":["MySQL"],"parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string","pattern":"^ems-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"mysql:DeleteMysqlSnapshot","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/lifecycle-defaults":{"get":{"operationId":"npm.lifecycle-defaults.get","summary":"Read the default that applies, and the platform default","description":"`npm:GetLifecyclePolicy` Read the default that applies, and the platform default.","tags":["npm registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"npm.lifecycle-defaults.put","summary":"Set the default and whether it is active, preview-only or off","description":"`npm:PutLifecyclePolicy` Set the default and whether it is active, preview-only or off. The platform default expires only prereleases nobody downloaded for 90 days; dist-tagged versions, the newest 10 and the latest release of every major are always kept.","tags":["npm registry"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"version":{"type":"string","const":"ews-lifecycle/v1"},"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"priority":{"type":"integer","minimum":1,"maximum":1000},"description":{"type":"string","maxLength":256},"select":{"type":"object","properties":{"tagStatus":{"default":"any","type":"string","enum":["tagged","untagged","any"]},"tagPatterns":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"tagPrefixes":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"namePrefix":{"type":"string","minLength":1,"maxLength":256},"prerelease":{"type":"boolean"}},"additionalProperties":false},"when":{"anyOf":[{"type":"object","properties":{"all":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["all"],"additionalProperties":false},{"type":"object","properties":{"any":{"minItems":1,"maxItems":4,"type":"array","items":{"anyOf":[{"type":"object","properties":{"countMoreThan":{"type":"integer","minimum":0,"maximum":100000}},"required":["countMoreThan"],"additionalProperties":false},{"type":"object","properties":{"sinceCreatedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceCreatedDays"],"additionalProperties":false},{"type":"object","properties":{"sinceLastUsedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sinceLastUsedDays"],"additionalProperties":false},{"type":"object","properties":{"sourceDeletedDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["sourceDeletedDays"],"additionalProperties":false}]}}},"required":["any"],"additionalProperties":false}]}},"required":["id","priority","select","when"],"additionalProperties":false}},"keep":{"default":{},"type":"object","properties":{"newest":{"type":"integer","minimum":0,"maximum":10000},"tagPatterns":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_.*@/+-]+$"}},"semverLatest":{"type":"boolean"}},"additionalProperties":false},"softDeleteDays":{"default":7,"type":"integer","minimum":0,"maximum":30}},"required":["version","rules"],"additionalProperties":false},"mode":{"type":"string","enum":["active","preview","off"]}},"required":["policy","mode"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:PutLifecyclePolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/lifecycle-defaults/preview":{"post":{"operationId":"npm.lifecycle-defaults.preview","summary":"What the default would expire across every package, as if active","description":"`npm:GetLifecyclePolicy` What the default would expire across every package, as if active.","tags":["npm registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/npm/api/packages":{"get":{"operationId":"npm.packages.list","summary":"List packages with their version count and latest tag","description":"`npm:ListPackages` List packages with their version count and latest tag.","tags":["npm registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:ListPackages","x-ews-mutates":false,"x-ews-sensitive":false}},"/npm/api/packages/{id}":{"get":{"operationId":"npm.packages.get","summary":"Describe a package with its versions and dist-tags","description":"`npm:DescribePackages` Describe a package with its versions and dist-tags.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:DescribePackages","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"npm.packages.update","summary":"Set a package description or visibility","description":"`npm:PublishPackage` Set a package description or visibility.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"visibility":{"type":"string","enum":["private","public"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:PublishPackage","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"npm.packages.delete","summary":"Delete a package and every version of it","description":"`npm:DeletePackage` Delete a package and every version of it.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:DeletePackage","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/packages/{id}/dist-tags/{tag}":{"put":{"operationId":"npm.packages.set-dist-tag","summary":"Point a dist-tag at a version","description":"`npm:ManageDistTags` Point a dist-tag at a version.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"tag","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z][a-zA-Z0-9._-]*$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+(?:[-+][0-9A-Za-z.-]+)*$"}},"required":["version"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:ManageDistTags","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"npm.packages.delete-dist-tag","summary":"Remove a dist-tag","description":"`npm:ManageDistTags` Remove a dist-tag.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"tag","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z][a-zA-Z0-9._-]*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:ManageDistTags","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/packages/{id}/expired-versions/restore":{"post":{"operationId":"npm.lifecycle-defaults.restore","summary":"Bring an expired version back","description":"`npm:RestoreExpiredItem` Bring an expired version back.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+(?:[-+][0-9A-Za-z.-]+)*$"}},"required":["version"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:RestoreExpiredItem","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/packages/{id}/lifecycle":{"get":{"operationId":"npm.lifecycle-defaults.package","summary":"Per version of one package: expire or keep, and why; the expired ones","description":"`npm:GetLifecyclePolicy` Per version of one package: expire or keep, and why; the expired ones.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetLifecyclePolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/npm/api/packages/{id}/versions/{version}":{"delete":{"operationId":"npm.packages.delete-version","summary":"Delete one published version","description":"`npm:DeletePackage` Delete one published version.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"version","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+(?:[-+][0-9A-Za-z.-]+)*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:DeletePackage","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/token":{"post":{"operationId":"npm.tokens.create","summary":"Mint a 12-hour registry token for the npm client","description":"`npm:GetAuthorizationToken` Mint a 12-hour registry token for the npm client.","tags":["npm registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/tokens":{"get":{"operationId":"npm.tokens.list","summary":"List your own live npm tokens (never their values)","description":"`npm:GetAuthorizationToken` List your own live npm tokens (never their values).","tags":["npm registry"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/npm/api/tokens/{id}":{"delete":{"operationId":"npm.tokens.revoke","summary":"Revoke one of your own npm tokens; the registry refuses it at once","description":"`npm:GetAuthorizationToken` Revoke one of your own npm tokens; the registry refuses it at once.","tags":["npm registry"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"npm:GetAuthorizationToken","x-ews-mutates":true,"x-ews-sensitive":false}},"/posture/api/controls":{"get":{"operationId":"posture.controls.list","summary":"List every control with its framework mappings and how many resources fail it","description":"`posture:ListControls` List every control with its framework mappings and how many resources fail it.","tags":["Security Posture"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ListControls","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/controls/{id}":{"get":{"operationId":"posture.controls.get","summary":"Describe one control","description":"`posture:GetControl` Describe one control.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","enum":["ec2.sg.world-open-admin-ports","ec2.instance.security-updates-pending","ec2.volume.unencrypted","s3.bucket.public","rds.db.publicly-accessible","rds.db.tls-not-required","rds.db.storage-unencrypted","rds.db.backup-insufficient","rds.db.deletion-protection-off","rds.db.restore-not-tested","iam.member.no-mfa","iam.access-key.unused-90d","iam.access-key.no-expiry-or-old","iam.policy.full-admin-wildcard","iam.audit.no-destination-or-short-retention","iam.org.sso-not-enforced","ecr.image.critical-fixable-cves","ecr.image.stale","ecr.image.runs-as-root","ecr.image.os-end-of-life","git.repo.default-branch-unprotected","git.repo.vulnerable-dependencies","git.repo.secret-alerts-open","git.repo.secret-push-protection-off","tls.certificate-expiring","lb.listener.http-without-redirect","dns.zone.dnssec-off","eks.cluster.public-endpoint-open","posture.control.error"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetControl","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/evaluations":{"get":{"operationId":"posture.evaluations.list","summary":"List recent evaluation passes","description":"`posture:ListEvaluations` List recent evaluation passes.","tags":["Security Posture"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ListEvaluations","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"posture.evaluations.start","summary":"Evaluate every control (or the ones named) now","description":"`posture:StartEvaluation` Evaluate every control (or the ones named) now. Asynchronous: the evaluation runs within seconds; read the summary afterwards. At most one request a minute per organization. Controls also run on every change to your resources and hourly.","tags":["Security Posture"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"controls":{"maxItems":29,"type":"array","items":{"type":"string","enum":["ec2.sg.world-open-admin-ports","ec2.instance.security-updates-pending","ec2.volume.unencrypted","s3.bucket.public","rds.db.publicly-accessible","rds.db.tls-not-required","rds.db.storage-unencrypted","rds.db.backup-insufficient","rds.db.deletion-protection-off","rds.db.restore-not-tested","iam.member.no-mfa","iam.access-key.unused-90d","iam.access-key.no-expiry-or-old","iam.policy.full-admin-wildcard","iam.audit.no-destination-or-short-retention","iam.org.sso-not-enforced","ecr.image.critical-fixable-cves","ecr.image.stale","ecr.image.runs-as-root","ecr.image.os-end-of-life","git.repo.default-branch-unprotected","git.repo.vulnerable-dependencies","git.repo.secret-alerts-open","git.repo.secret-push-protection-off","tls.certificate-expiring","lb.listener.http-without-redirect","dns.zone.dnssec-off","eks.cluster.public-endpoint-open","posture.control.error"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:StartEvaluation","x-ews-mutates":true,"x-ews-sensitive":false}},"/posture/api/evaluations/{id}":{"get":{"operationId":"posture.evaluations.get","summary":"Show one evaluation pass","description":"`posture:ListEvaluations` Show one evaluation pass.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ListEvaluations","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/findings":{"get":{"operationId":"posture.findings.list","summary":"List findings, worst first (default: open and accepted)","description":"`posture:ListFindings` List findings, worst first (default: open and accepted). Findings name your weak spots: do not paste them into shared channels, tickets or CI logs. Every allowed read is recorded in the audit log.","tags":["Security Posture"],"parameters":[{"name":"state","in":"query","required":false,"schema":{"type":"string","maxLength":2000}},{"name":"severity","in":"query","required":false,"schema":{"type":"string","maxLength":2000}},{"name":"control","in":"query","required":false,"schema":{"type":"string","maxLength":2000}},{"name":"service","in":"query","required":false,"schema":{"type":"string","maxLength":40,"pattern":"^[a-z0-9]+$"}},{"name":"project","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}},{"name":"resource","in":"query","required":false,"schema":{"type":"string","maxLength":500,"pattern":"^rn:(?:dcloud|ews):"}},{"name":"limit","in":"query","required":false,"schema":{"default":100,"type":"integer","minimum":1,"maximum":500}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"type":"integer","minimum":0,"maximum":100000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ListFindings","x-ews-mutates":false,"x-ews-sensitive":true}},"/posture/api/findings/{id}":{"get":{"operationId":"posture.findings.get","summary":"Show one finding with its evidence, how to fix it, its history and acceptances","description":"`posture:GetFinding` Show one finding with its evidence, how to fix it, its history and acceptances. Findings name your weak spots: do not paste them into shared channels, tickets or CI logs. Every allowed read is recorded in the audit log.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetFinding","x-ews-mutates":false,"x-ews-sensitive":true}},"/posture/api/findings/{id}/acceptance":{"post":{"operationId":"posture.findings.accept","summary":"Accept a finding as a risk, with a reason, an owner and an expiry","description":"`posture:AcceptFinding` Accept a finding as a risk, with a reason, an owner and an expiry. A critical finding needs posture:AcceptCriticalFinding as well. At most 90 days for critical and high, 365 for medium and low. The acceptance lapses when the finding gets more severe or lists a CVE it did not list when accepted.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":10,"maxLength":2000},"expiresInDays":{"default":90,"type":"integer","minimum":1,"maximum":365},"ownerIamUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:AcceptFinding","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["posture:AcceptCriticalFinding"]}},"/posture/api/findings/{id}/acceptance/revoke":{"post":{"operationId":"posture.findings.revoke-acceptance","summary":"End a finding’s acceptance, so it counts as open again","description":"`posture:RevokeAcceptance` End a finding’s acceptance, so it counts as open again.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":2000}},"required":["reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:RevokeAcceptance","x-ews-mutates":true,"x-ews-sensitive":false}},"/posture/api/frameworks/{id}":{"get":{"operationId":"posture.frameworks.get","summary":"Show the status of every control of a framework","description":"`posture:GetFrameworkStatus` Show the status of every control of a framework.","tags":["Security Posture"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","enum":["iso27001","c5"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetFrameworkStatus","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/report-keys":{"get":{"operationId":"posture.reports.keys","summary":"List the public keys reports are signed with","description":"`posture:GetSummary` List the public keys reports are signed with.","tags":["Security Posture"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetSummary","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/reports":{"get":{"operationId":"posture.reports.export","summary":"Export a signed statement of what was checked, when, and with what result","description":"`posture:ExportReport` Export a signed statement of what was checked, when, and with what result. Ed25519 over canonicalJson(statement); verify with the public key in the response or from report-keys. The statement names the evidence snapshot and audit chain head it was built from. Findings name your weak spots: do not paste them into shared channels, tickets or CI logs. Every allowed read is recorded in the audit log.","tags":["Security Posture"],"parameters":[{"name":"framework","in":"query","required":false,"schema":{"default":"iso27001","type":"string","enum":["iso27001","c5"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ExportReport","x-ews-mutates":false,"x-ews-sensitive":true}},"/posture/api/reports/pdf":{"get":{"operationId":"posture.reports.export-pdf","summary":"Export the signed statement as a PDF for print or an auditor","description":"`posture:ExportReport` Export the signed statement as a PDF for print or an auditor. The same statement as `export`, laid out per framework control, check, open finding and accepted risk; statement.json and signature.json are attached to the PDF, so the signature can be verified from the file alone. Findings name your weak spots: do not paste them into shared channels, tickets or CI logs. Every allowed read is recorded in the audit log.","tags":["Security Posture"],"parameters":[{"name":"framework","in":"query","required":false,"schema":{"default":"iso27001","type":"string","enum":["iso27001","c5"]}}],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:ExportReport","x-ews-mutates":false,"x-ews-sensitive":true}},"/posture/api/resource-findings":{"get":{"operationId":"posture.summary.resources","summary":"Count open findings per resource of one type (the badge on its page and list row)","description":"`posture:GetSummary` Count open findings per resource of one type (the badge on its page and list row). Keyed by resource id (a bucket by its name): open findings, the most severe, checks run. Resources with nothing checked are left out. Counts only, no finding details.","tags":["Security Posture"],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["ec2:instance","ec2:security-group","ec2:volume","s3:bucket","rds:db","docdb:cluster","git:repository","ecr:repository","iam:user","iam:access-key"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetSummary","x-ews-mutates":false,"x-ews-sensitive":false}},"/posture/api/summary":{"get":{"operationId":"posture.summary.get","summary":"Show the security score and what is open right now, by severity and service","description":"`posture:GetSummary` Show the security score and what is open right now, by severity and service. Counts only, no finding details. `project` limits it to a project’s resources; `resource` (an RN) to one resource. The score is the severity-weighted share of passing checks; accepted findings count as passing in the score but never in framework coverage.","tags":["Security Posture"],"parameters":[{"name":"project","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}},{"name":"resource","in":"query","required":false,"schema":{"type":"string","maxLength":500,"pattern":"^rn:(?:dcloud|ews):"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"posture:GetSummary","x-ews-mutates":false,"x-ews-sensitive":false}},"/privacyvpn/api/accounts":{"get":{"operationId":"privacyvpn.accounts.list","summary":"List the organization’s VPN accounts and this month’s token use","description":"`privacyvpn:ListAccounts` List the organization’s VPN accounts and this month’s token use.","tags":["Privacy VPN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:ListAccounts","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"privacyvpn.accounts.create","summary":"Create a VPN account; its number is shown once","description":"`privacyvpn:CreateAccount` Create a VPN account; its number is shown once. The number is the account’s only credential (for apps that sign in with it); Deutsche Cloud keeps a hash. Preview price: €5 a month flat.","tags":["Privacy VPN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._-]*$"},"deviceLimit":{"default":5,"type":"integer","minimum":1,"maximum":20}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:CreateAccount","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/accounts/{id}":{"get":{"operationId":"privacyvpn.accounts.get","summary":"Describe a VPN account","description":"`privacyvpn:ListAccounts` Describe a VPN account.","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:ListAccounts","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"privacyvpn.accounts.update","summary":"Rename an account, change its device limit, suspend or resume it","description":"`privacyvpn:UpdateAccount` Rename an account, change its device limit, suspend or resume it.","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9 ._-]*$"},"deviceLimit":{"type":"integer","minimum":1,"maximum":20},"state":{"type":"string","enum":["active","suspended"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:UpdateAccount","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"privacyvpn.accounts.delete","summary":"Delete a VPN account (devices already registered work until the month ends)","description":"`privacyvpn:DeleteAccount` Delete a VPN account (devices already registered work until the month ends).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:DeleteAccount","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/accounts/{id}/tokens":{"post":{"operationId":"privacyvpn.accounts.issue-tokens","summary":"Have blinded access tokens signed (RFC 9474) for an account","description":"`privacyvpn:IssueAccessTokens` Have blinded access tokens signed (RFC 9474) for an account. The issuer never sees the tokens, only blinded values, so it cannot tell which device a token later registers. Budget: device limit + 2 per month. `dcloud vpn connect` does blinding, issue and registration for you.","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"epoch":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"blinded":{"minItems":1,"maxItems":22,"type":"array","items":{"type":"string","minLength":300,"maxLength":400,"pattern":"^[A-Za-z0-9_-]+$"},"description":"Blinded token messages, base64url (RFC 9474)"}},"required":["epoch","blinded"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:IssueAccessTokens","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/locations":{"get":{"operationId":"privacyvpn.locations.list","summary":"List exit locations with their endpoints and load","description":"`privacyvpn:DescribeExitLocations` List exit locations with their endpoints and load.","tags":["Privacy VPN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:DescribeExitLocations","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"privacyvpn.locations.create","summary":"Create an exit location; returns the user data for its launch template","description":"`privacyvpn:CreateExitLocation` Create an exit location; returns the user data for its launch template. Platform org only. Makes the location’s WireGuard key and bootstrap token and returns the exit recipe with the token in it, once. Then create a security group (UDP 51820, 443, 3478), a launch template with that user data, an auto scaling group, and Elastic IPs, and attach them with `update` and `add-address` — scripts/privacy-vpn/fleet.ts does all of it.","tags":["Privacy VPN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$","description":"Country code and city code, e.g. de-fsn"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2, e.g. DE"},"city":{"type":"string","minLength":1,"maxLength":64},"regionId":{"type":"string","minLength":1,"maxLength":32},"zoneId":{"type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"scope":{"default":"eu","description":"eu: in the EU, every key; global: outside, only keys registered for it","type":"string","enum":["eu","global"]},"serverType":{"type":"string","minLength":1,"maxLength":32,"description":"Instance type of the exits; the cheapest in stock is enough (1 vCPU)"},"minExits":{"default":1,"type":"integer","minimum":0,"maximum":50},"maxExits":{"default":4,"type":"integer","minimum":1,"maximum":50},"targetPeersPerExit":{"default":300,"type":"integer","minimum":1,"maximum":10000},"maxExitAgeHours":{"default":24,"type":"integer","minimum":1,"maximum":168},"inspectSsh":{"default":false,"description":"Open SSH on the exits so they can be inspected by hand (shown on the public page)","type":"boolean"}},"required":["id","country","city","regionId","zoneId","serverType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:CreateExitLocation","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/locations/{id}":{"get":{"operationId":"privacyvpn.locations.get","summary":"Describe an exit location (the platform org also sees its exits and traffic)","description":"`privacyvpn:DescribeExitLocations` Describe an exit location (the platform org also sees its exits and traffic).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:DescribeExitLocations","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"privacyvpn.locations.update","summary":"Change a location’s size, state, max exit age, or its group","description":"`privacyvpn:UpdateExitLocation` Change a location’s size, state, max exit age, or its group.","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["active","disabled"]},"minExits":{"type":"integer","minimum":0,"maximum":50},"maxExits":{"type":"integer","minimum":1,"maximum":50},"targetPeersPerExit":{"type":"integer","minimum":1,"maximum":10000},"maxExitAgeHours":{"type":"integer","minimum":1,"maximum":168},"groupId":{"description":"The auto scaling group that runs the exits (asg-…)","type":"string","pattern":"^asg-[0-9a-f]{8}$"},"launchTemplateId":{"type":"string","pattern":"^lt-[0-9a-f]{8}$"},"securityGroupId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"vpcId":{"description":"The location’s own VPC: exits outside it are refused at registration","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:UpdateExitLocation","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"privacyvpn.locations.delete","summary":"Delete an exit location (its group and addresses are deleted through their own APIs)","description":"`privacyvpn:DeleteExitLocation` Delete an exit location (its group and addresses are deleted through their own APIs).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:DeleteExitLocation","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/locations/{id}/addresses":{"post":{"operationId":"privacyvpn.locations.add-address","summary":"Give a location a stable address (an Elastic IP the controller keeps on a healthy exit)","description":"`privacyvpn:UpdateExitLocation` Give a location a stable address (an Elastic IP the controller keeps on a healthy exit).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"elasticIpId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"An Elastic IP of the platform org"}},"required":["elasticIpId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:UpdateExitLocation","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/locations/{id}/addresses/{addressId}":{"delete":{"operationId":"privacyvpn.locations.remove-address","summary":"Take a stable address out of a location (configs naming it stop working)","description":"`privacyvpn:UpdateExitLocation` Take a stable address out of a location (configs naming it stop working).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:UpdateExitLocation","x-ews-mutates":true,"x-ews-sensitive":false}},"/privacyvpn/api/locations/{id}/events":{"get":{"operationId":"privacyvpn.locations.events","summary":"Read the fleet controller’s decisions for a location (platform org)","description":"`privacyvpn:DescribeExitLocations` Read the fleet controller’s decisions for a location (platform org).","tags":["Privacy VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{3,8}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"privacyvpn:DescribeExitLocations","x-ews-mutates":false,"x-ews-sensitive":false}},"/projects/api/from-tag":{"post":{"operationId":"projects.projects.from-tag","summary":"Turn a tag key into projects: one per value, each resource carrying it (still in Default) moved in","description":"`projects:CreateProject` Turn a tag key into projects: one per value, each resource carrying it (still in Default) moved in. Only the organization’s owner, signed in (not an access key). Resources already moved stay; the tag itself stays. A required key becomes optional (it is the project now), which also needs tags:ManageTagPolicy.","tags":["Projects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:CreateProject","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["projects:MoveResource","tags:ManageTagPolicy"]}},"/projects/api/move":{"post":{"operationId":"projects.projects.move","summary":"Move a resource, with its parts, to another project","description":"`projects:MoveResource` Move a resource, with its parts, to another project. Checked on the project it leaves and the one it enters. Its parts go with it (a cluster’s node groups and machines, a database’s endpoint and backup bucket).","tags":["Projects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","description":"What kind of resource, e.g. rds:db"},"resourceId":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The id the resource is tagged under"},"project":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$","description":"The target project"}},"required":["resourceType","resourceId","project"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:MoveResource","x-ews-mutates":true,"x-ews-sensitive":false}},"/projects/api/projects":{"get":{"operationId":"projects.projects.list","summary":"The organization’s projects, Default first, with how many resources each holds","description":"`projects:ListProjects` The organization’s projects, Default first, with how many resources each holds. Creates go into the project named by the X-EWS-Project header (its slug), or Default when it is left out. Policies can limit creates to a project with the condition key ews:RequestProject.","tags":["Projects"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"projects.projects.create","summary":"Create a project","description":"`projects:CreateProject` Create a project.","tags":["Projects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"What people read; can be changed"},"slug":{"description":"Used in X-EWS-Project and policy conditions; never changes. Default: from the name","type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:CreateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/projects/api/projects/{slug}":{"patch":{"operationId":"projects.projects.update","summary":"Rename a project (its slug never changes)","description":"`projects:UpdateProject` Rename a project (its slug never changes).","tags":["Projects"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"What people read; can be changed"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"projects.projects.delete","summary":"Delete a project; what is in it moves to Default","description":"`projects:DeleteProject` Delete a project; what is in it moves to Default. Also needs projects:MoveResource on the Default project. Default cannot be deleted.","tags":["Projects"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:DeleteProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/projects/api/projects/{slug}/quotas":{"get":{"operationId":"projects.projects.quotas","summary":"The quotas a project can cap, with its cap and use (null without a cap) and the organization’s own limit","description":"`projects:ListProjects` The quotas a project can cap, with its cap and use (null without a cap) and the organization’s own limit. Count quotas of resources that land in the project a create names (databases, clusters, machines, buckets…); parts follow their owner and are not capped per project.","tags":["Projects"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/projects/api/projects/{slug}/quotas/{quotaId}":{"put":{"operationId":"projects.projects.set-quota","summary":"Cap a quota in a project: creates and moves into it beyond the cap are refused","description":"`projects:UpdateProject` Cap a quota in a project: creates and moves into it beyond the cap are refused. A refusal is the usual 409 QuotaExceeded, with quota.project set. The organization’s own quota applies first.","tags":["Projects"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}},{"name":"quotaId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9-]+\\.[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","minimum":0,"maximum":1000000,"description":"At most this many in the project; the organization’s own limit still applies"}},"required":["limit"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"projects.projects.remove-quota","summary":"Remove a project’s cap on a quota","description":"`projects:UpdateProject` Remove a project’s cap on a quota.","tags":["Projects"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}},{"name":"quotaId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9-]+\\.[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:UpdateProject","x-ews-mutates":true,"x-ews-sensitive":false}},"/projects/api/resource":{"get":{"operationId":"projects.projects.of","summary":"The project one resource is in","description":"`projects:ListProjects` The project one resource is in.","tags":["Projects"],"parameters":[{"name":"resourceType","in":"query","required":true,"schema":{"type":"string","description":"What kind of resource, e.g. rds:db"}},{"name":"resourceId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The id the resource is tagged under"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"projects:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/queue/api/queues":{"get":{"operationId":"queue.queues.list","summary":"List queues with their message counts","description":"`queue:ListQueues` List queues with their message counts.","tags":["Queues"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:ListQueues","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"queue.queues.create","summary":"Create a queue","description":"`queue:CreateQueue` Create a queue. Unset attributes take the defaults: visibility timeout 30 s, retention 4 days, no delay, no long polling, 256 KiB messages. deadLetterQueue names another queue of the organization; after maxReceiveCount receives a message moves there. 409 QueueAlreadyExists when the name is taken. fifo: true makes a FIFO queue (the name must end in .fifo, and a .fifo name requires it; fixed at creation): sends name a messageGroupId, each group is delivered in order with one batch in flight at a time, and sends are deduplicated for five minutes by messageDeduplicationId, or by the body with contentBasedDeduplication. A FIFO queue's dead-letter queue must be FIFO.","tags":["Queues"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Name of the queue, unique in the organization and region; a FIFO queue’s name ends in .fifo"},"fifo":{"description":"Create a FIFO queue, which delivers each message group in order and deduplicates sends; cannot be changed later (default false)","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"visibilityTimeoutSeconds":{"description":"Seconds a received message stays hidden from other consumers before it can be received again; 30 for a new queue","type":"integer","minimum":0,"maximum":43200},"retentionSeconds":{"description":"Seconds a message is kept before it is deleted unreceived; applies to messages sent afterwards; 4 days for a new queue","type":"integer","minimum":60,"maximum":1209600},"delaySeconds":{"description":"Seconds a newly sent message stays invisible before it can be received; 0 for a new queue","type":"integer","minimum":0,"maximum":900},"receiveWaitSeconds":{"description":"Seconds a receive waits for a message when it names no wait of its own; 0 answers at once; 0 for a new queue","type":"integer","minimum":0,"maximum":20},"maximumMessageBytes":{"description":"Largest message the queue accepts, in bytes, counting the body and attributes; 256 KiB for a new queue","type":"integer","minimum":1024,"maximum":262144},"deadLetterQueue":{"description":"Another queue of the organization (name) that receives a message after it has been received maxReceiveCount times without being deleted; null removes it; none for a new queue","anyOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"maxReceiveCount":{"type":"integer","minimum":1,"maximum":1000}},"required":["name","maxReceiveCount"]},{"type":"null"}]},"contentBasedDeduplication":{"description":"FIFO queues only: a send without messageDeduplicationId is deduplicated by the SHA-256 of its body; false for a new queue","type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:CreateQueue","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}":{"get":{"operationId":"queue.queues.get","summary":"One queue: its attributes and visible, in-flight and delayed message counts","description":"`queue:GetQueueAttributes` One queue: its attributes and visible, in-flight and delayed message counts.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:GetQueueAttributes","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"queue.queues.set-attributes","summary":"Change a queue’s attributes or its dead-letter queue","description":"`queue:SetQueueAttributes` Change a queue’s attributes or its dead-letter queue. Only the fields sent change. deadLetterQueue: null removes the dead-letter queue.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"visibilityTimeoutSeconds":{"description":"Seconds a received message stays hidden from other consumers before it can be received again; 30 for a new queue","type":"integer","minimum":0,"maximum":43200},"retentionSeconds":{"description":"Seconds a message is kept before it is deleted unreceived; applies to messages sent afterwards; 4 days for a new queue","type":"integer","minimum":60,"maximum":1209600},"delaySeconds":{"description":"Seconds a newly sent message stays invisible before it can be received; 0 for a new queue","type":"integer","minimum":0,"maximum":900},"receiveWaitSeconds":{"description":"Seconds a receive waits for a message when it names no wait of its own; 0 answers at once; 0 for a new queue","type":"integer","minimum":0,"maximum":20},"maximumMessageBytes":{"description":"Largest message the queue accepts, in bytes, counting the body and attributes; 256 KiB for a new queue","type":"integer","minimum":1024,"maximum":262144},"deadLetterQueue":{"description":"Another queue of the organization (name) that receives a message after it has been received maxReceiveCount times without being deleted; null removes it; none for a new queue","anyOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"maxReceiveCount":{"type":"integer","minimum":1,"maximum":1000}},"required":["name","maxReceiveCount"]},{"type":"null"}]},"contentBasedDeduplication":{"description":"FIFO queues only: a send without messageDeduplicationId is deduplicated by the SHA-256 of its body; false for a new queue","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:SetQueueAttributes","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"queue.queues.delete","summary":"Delete a queue and every message in it","description":"`queue:DeleteQueue` Delete a queue and every message in it. Refused (409) while another queue uses it as its dead-letter queue.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:DeleteQueue","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages":{"post":{"operationId":"queue.messages.send","summary":"Send one message","description":"`queue:SendMessage` Send one message. body is text (no control characters besides tab, LF, CR); attributes are up to 10 string pairs. delaySeconds (0–900) keeps it invisible that long (standard queues only). On a FIFO queue messageGroupId is required, and messageDeduplicationId too unless the queue has contentBasedDeduplication; a repeat within five minutes answers the original messageId with duplicate: true. Answers 201 with messageId, md5OfBody and, on FIFO, sequenceNumber.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"description":"The message content, as text"},"delaySeconds":{"description":"Seconds the message stays invisible before it can be received; standard queues only (default: the queue’s delay)","type":"integer","minimum":0,"maximum":900},"attributes":{"description":"Name–value string pairs delivered with the message (default none)","type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,256}$"},"additionalProperties":{"type":"string","maxLength":262144}},"messageGroupId":{"description":"FIFO queues: required; messages of one group are delivered in order, one batch at a time. Ignored on a standard queue","type":"string","pattern":"^[A-Za-z0-9!\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~]{1,128}$"},"messageDeduplicationId":{"description":"FIFO queues only: a send repeating this id within five minutes is accepted but not stored again. Required unless the queue has content-based deduplication","type":"string","pattern":"^[A-Za-z0-9!\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~]{1,128}$"}},"required":["body"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:SendMessage","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages/{receiptHandle}":{"delete":{"operationId":"queue.messages.delete","summary":"Delete a processed message by its receipt handle","description":"`queue:DeleteMessage` Delete a processed message by its receipt handle. Fails with ReceiptHandleIsInvalid when the message was received again since this receipt was issued.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}},{"name":"receiptHandle","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:DeleteMessage","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages/batch":{"post":{"operationId":"queue.messages.send-batch","summary":"Send up to 10 messages at once, with a result per entry","description":"`queue:SendMessage` Send up to 10 messages at once, with a result per entry. Each entry carries a caller-chosen id, unique in the batch, used to match results. Answers { successful, failed }: an entry too large for the queue fails alone, as on SQS. A batch over 256 KiB in all, or a queue at capacity, fails the whole call.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"body":{"type":"string","minLength":1,"description":"The message content, as text"},"delaySeconds":{"description":"Seconds the message stays invisible before it can be received; standard queues only (default: the queue’s delay)","type":"integer","minimum":0,"maximum":900},"attributes":{"description":"Name–value string pairs delivered with the message (default none)","type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,256}$"},"additionalProperties":{"type":"string","maxLength":262144}},"messageGroupId":{"description":"FIFO queues: required; messages of one group are delivered in order, one batch at a time. Ignored on a standard queue","type":"string","pattern":"^[A-Za-z0-9!\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~]{1,128}$"},"messageDeduplicationId":{"description":"FIFO queues only: a send repeating this id within five minutes is accepted but not stored again. Required unless the queue has content-based deduplication","type":"string","pattern":"^[A-Za-z0-9!\"#$%&'()*+,\\-./:;<=>?@[\\\\\\]^_`{|}~]{1,128}$"},"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,80}$"}},"required":["body","id"]},"description":"The messages to send, each a single send’s fields plus an id of your choosing, unique in the batch, that matches it to its result"}},"required":["entries"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:SendMessage","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages/delete-batch":{"post":{"operationId":"queue.messages.delete-batch","summary":"Delete up to 10 processed messages by receipt handle","description":"`queue:DeleteMessage` Delete up to 10 processed messages by receipt handle. Answers { successful, failed } per entry id; a failed entry does not fail the call.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,80}$"},"receiptHandle":{"type":"string","minLength":1,"maxLength":200}},"required":["id","receiptHandle"]},"description":"The messages to delete, each a receiptHandle from the receive plus an id of your choosing, unique in the batch, that matches it to its result"}},"required":["entries"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:DeleteMessage","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages/visibility":{"post":{"operationId":"queue.messages.change-visibility","summary":"Extend or shorten how long a received message stays hidden","description":"`queue:ChangeMessageVisibility` Extend or shorten how long a received message stays hidden. 0 makes the message visible again at once.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"receiptHandle":{"type":"string","minLength":1,"maxLength":200,"description":"The receipt handle the message was last received with"},"visibilityTimeoutSeconds":{"type":"integer","minimum":0,"maximum":43200,"description":"Seconds from now the message stays hidden; 0 makes it receivable again at once"}},"required":["receiptHandle","visibilityTimeoutSeconds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:ChangeMessageVisibility","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/messages/visibility-batch":{"post":{"operationId":"queue.messages.change-visibility-batch","summary":"Change the visibility timeout of up to 10 received messages","description":"`queue:ChangeMessageVisibility` Change the visibility timeout of up to 10 received messages. Answers { successful, failed } per entry id; a failed entry (MessageNotInflight, ReceiptHandleIsInvalid) does not fail the call.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"receiptHandle":{"type":"string","minLength":1,"maxLength":200,"description":"The receipt handle the message was last received with"},"visibilityTimeoutSeconds":{"type":"integer","minimum":0,"maximum":43200,"description":"Seconds from now the message stays hidden; 0 makes it receivable again at once"},"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,80}$"}},"required":["receiptHandle","visibilityTimeoutSeconds","id"]},"description":"The messages to change, each a receiptHandle and visibilityTimeoutSeconds as for a single change plus an id of your choosing, unique in the batch, that matches it to its result"}},"required":["entries"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:ChangeMessageVisibility","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/metrics":{"get":{"operationId":"queue.queues.metrics","summary":"Message counts over time (about 180 points over the range)","description":"`queue:GetQueueAttributes` Message counts over time (about 180 points over the range).","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}},{"name":"hours","in":"query","required":false,"schema":{"description":"How far back, in hours (default 3, at most 14 days)","type":"integer","minimum":1,"maximum":336}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:GetQueueAttributes","x-ews-mutates":false,"x-ews-sensitive":false}},"/queue/api/queues/{name}/purge":{"post":{"operationId":"queue.queues.purge","summary":"Delete every message in a queue, keeping the queue","description":"`queue:PurgeQueue` Delete every message in a queue, keeping the queue.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:PurgeQueue","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/receive":{"post":{"operationId":"queue.messages.receive","summary":"Receive up to 10 messages, hiding them for the visibility timeout","description":"`queue:ReceiveMessage` Receive up to 10 messages, hiding them for the visibility timeout. waitSeconds (0–20) long-polls until a message arrives. Each message carries a receiptHandle: delete it with messages delete once processed, or it becomes visible again when the timeout ends. Changes state: received messages are hidden from other consumers.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxMessages":{"description":"Most messages to return (default 1)","type":"integer","minimum":1,"maximum":10},"visibilityTimeoutSeconds":{"description":"Seconds the received messages stay hidden from other consumers (default: the queue’s visibility timeout)","type":"integer","minimum":0,"maximum":43200},"waitSeconds":{"description":"Seconds to wait for a message when none is available; 0 answers at once (default: the queue’s receive wait)","type":"integer","minimum":0,"maximum":20}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:ReceiveMessage","x-ews-mutates":true,"x-ews-sensitive":false}},"/queue/api/queues/{name}/redrive":{"post":{"operationId":"queue.queues.redrive","summary":"Move a dead-letter queue’s messages back to their source queues","description":"`queue:StartMessageMoveTask` Move a dead-letter queue’s messages back to their source queues. Without destination each message returns to the queue it was dead-lettered from; with one, all go there. Needs queue:SendMessage on every destination too. Messages arrive as new deliveries (receive count 0). In-flight messages, and ones whose source queue is gone, stay. Runs to completion and answers { taskId, moved, remaining }.","tags":["Queues"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$","description":"Queue name (1–80 letters, digits, - or _)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"description":"Queue to move every message to (default: each message goes back to the queue it was dead-lettered from)","type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"queue:StartMessageMoveTask","x-ews-mutates":true,"x-ews-sensitive":false}},"/quotas/api/preview-access":{"get":{"operationId":"quotas.preview-access.list","summary":"List the preview services the organization has asked for","description":"`quotas:ListPreviewAccessRequests` List the preview services the organization has asked for.","tags":["Service quotas"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:ListPreviewAccessRequests","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"quotas.preview-access.request","summary":"Ask for access to a service in preview","description":"`quotas:RequestPreviewAccess` Ask for access to a service in preview. One request per service and organization; asking again updates the note. Deutsche Cloud staff grant access; until then the service’s API answers 404 for the organization.","tags":["Service quotas"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"feature":{"type":"string","enum":["eks","functions","sandbox","cloudshell"]},"note":{"type":"string","maxLength":500}},"required":["feature"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:RequestPreviewAccess","x-ews-mutates":true,"x-ews-sensitive":false}},"/quotas/api/quotas":{"get":{"operationId":"quotas.quotas.list","summary":"List every service quota with its applied value and usage","description":"`quotas:ListServiceQuotas` List every service quota with its applied value and usage. One row per quota: per region for a region quota, the fullest parent for a per-parent quota (e.g. the cluster with the most node groups). usage is null for a rate.","tags":["Service quotas"],"parameters":[{"name":"service","in":"query","required":false,"schema":{"type":"string","maxLength":40,"pattern":"^[a-z0-9]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:ListServiceQuotas","x-ews-mutates":false,"x-ews-sensitive":false}},"/quotas/api/quotas/{quotaId}":{"get":{"operationId":"quotas.quotas.get","summary":"Describe one quota: default, applied value, usage, increase requests","description":"`quotas:GetServiceQuota` Describe one quota: default, applied value, usage, increase requests.","tags":["Service quotas"],"parameters":[{"name":"quotaId","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+\\.[a-z0-9]+(-[a-z0-9]+)*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:GetServiceQuota","x-ews-mutates":false,"x-ews-sensitive":false}},"/quotas/api/requests":{"get":{"operationId":"quotas.requests.list","summary":"List increase requests and their outcome","description":"`quotas:ListQuotaIncreaseRequests` List increase requests and their outcome.","tags":["Service quotas"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","approved","denied","cancelled"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:ListQuotaIncreaseRequests","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"quotas.requests.request-increase","summary":"Ask for a higher value of an adjustable quota","description":"`quotas:RequestServiceQuotaIncrease` Ask for a higher value of an adjustable quota. Cheap counts are approved at once up to twice the standard default; everything else is decided by Deutsche Cloud staff, and the decision arrives as a \"Service Quota Increase Request Updated\" event.","tags":["Service quotas"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quotaId":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+\\.[a-z0-9]+(-[a-z0-9]+)*$"},"scopeId":{"type":"string","minLength":1,"maxLength":128},"requestedValue":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"reason":{"type":"string","minLength":10,"maxLength":2000}},"required":["quotaId","requestedValue","reason"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:RequestServiceQuotaIncrease","x-ews-mutates":true,"x-ews-sensitive":false}},"/quotas/api/requests/{id}/cancel":{"post":{"operationId":"quotas.requests.cancel","summary":"Withdraw a pending request","description":"`quotas:CancelQuotaIncreaseRequest` Withdraw a pending request.","tags":["Service quotas"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"quotas:CancelQuotaIncreaseRequest","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers":{"get":{"operationId":"rabbitmq.brokers.list","summary":"List RabbitMQ brokers","description":"`rabbitmq:DescribeRabbitmqBrokers` List RabbitMQ brokers.","tags":["RabbitMQ"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqBrokers","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rabbitmq.brokers.create","summary":"Create a RabbitMQ broker","description":"`rabbitmq:CreateRabbitmqBroker` Create a RabbitMQ broker. Private: without vpcId it joins the default VPC, where deployed apps run. TLS only (AMQPS 5671). `creating` until every node runs in one cluster and the admin user is in place, usually 3–5 minutes. The admin password is filed in Secrets as RABBITMQ_<IDENTIFIER>_ADMIN_PASSWORD. Queues declared without a type are quorum queues. With nodes: 1 nothing is replicated.","tags":["RabbitMQ"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$"},"nodeType":{"type":"string","minLength":1,"maxLength":32,"description":"An instance type from node-types, e.g. performance-2. The provider’s own type names are still accepted, deprecated."},"nodes":{"default":1,"description":"1: one machine, queues NOT replicated. 3: one cluster across zones behind a private balancer; quorum queues keep serving when a node goes","anyOf":[{"type":"number","const":1},{"type":"number","const":3}]},"volumeSizeGib":{"default":20,"description":"Each node’s data volume (messages and quorum-queue logs)","type":"integer","minimum":10,"maximum":10000},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kmsKeyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"exportId":{"description":"Make the broker from this definitions export; needs rabbitmq:CreateRabbitmqBroker on the export","type":"string","pattern":"^rmd-[0-9a-f]{12}$"},"tags":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"alarmEmails":{"default":[],"description":"Who the default alarms in Monitoring email (no quorum, memory/disk alarm, disk); nobody by default","maxItems":10,"type":"array","items":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["identifier","nodeType"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:CreateRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}":{"get":{"operationId":"rabbitmq.brokers.get","summary":"One broker with its nodes (alarms, memory, disk, partitions), users, message rates and its 20 deepest queues with their leaders","description":"`rabbitmq:DescribeRabbitmqBrokers` One broker with its nodes (alarms, memory, disk, partitions), users, message rates and its 20 deepest queues with their leaders.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqBrokers","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"rabbitmq.brokers.delete","summary":"Delete a broker, its machines, volumes, messages, balancer and passwords","description":"`rabbitmq:DeleteRabbitmqBroker` Delete a broker, its machines, volumes, messages, balancer and passwords. Its daily exports go with it; manual ones stay.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DeleteRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/events":{"get":{"operationId":"rabbitmq.brokers.events","summary":"Activity: provisioning, nodes going down and back, alarms, users applied, exports, what the nodes reported","description":"`rabbitmq:DescribeRabbitmqBrokers` Activity: provisioning, nodes going down and back, alarms, users applied, exports, what the nodes reported.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqBrokers","x-ews-mutates":false,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/exports":{"post":{"operationId":"rabbitmq.brokers.export","summary":"Export the broker’s definitions now","description":"`rabbitmq:CreateRabbitmqExport` Export the broker’s definitions now. Answers 202 with the export `pending`; a node takes it at its next report (within 30 s). Users (with password hashes), queues, exchanges, bindings and policies — not messages.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:CreateRabbitmqExport","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/maintenance/cancel":{"post":{"operationId":"rabbitmq.brokers.cancel-maintenance","summary":"Stop a rolling restart or patch run; nodes already done stay done","description":"`rabbitmq:UpgradeRabbitmqBroker` Stop a rolling restart or patch run; nodes already done stay done.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:UpgradeRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/maintenance/resume":{"post":{"operationId":"rabbitmq.brokers.resume-maintenance","summary":"Resume a paused rolling restart or patch run (its current node starts again)","description":"`rabbitmq:UpgradeRabbitmqBroker` Resume a paused rolling restart or patch run (its current node starts again).","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:UpgradeRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/patch":{"post":{"operationId":"rabbitmq.brokers.patch","summary":"Patch the nodes’ operating system now, one node at a time (a reboot if the kernel asks)","description":"`rabbitmq:UpgradeRabbitmqBroker` Patch the nodes’ operating system now, one node at a time (a reboot if the kernel asks). Security updates also install nightly by themselves; reboots then happen in the platform window, one node at a time, only while every node runs without alarms.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:UpgradeRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/reboot":{"post":{"operationId":"rabbitmq.brokers.reboot","summary":"Restart one node (the first unless nodeId names another) — with 3 nodes, a failover test","description":"`rabbitmq:RebootRabbitmqNode` Restart one node (the first unless nodeId names another) — with 3 nodes, a failover test.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","pattern":"^rmq-[0-9a-f]{12}-[0-2]$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:RebootRabbitmqNode","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/upgrade":{"post":{"operationId":"rabbitmq.brokers.upgrade","summary":"Restart the broker onto the newest patch release of its minor, one node at a time","description":"`rabbitmq:UpgradeRabbitmqBroker` Restart the broker onto the newest patch release of its minor, one node at a time. Each node drains first (its quorum queue leaders move, its connections close), pulls the image and restarts, and every quorum queue must have all its members online again before the next node. A node that does not come back pauses the rollout. With one node it is downtime.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:UpgradeRabbitmqBroker","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/users":{"get":{"operationId":"rabbitmq.users.list","summary":"List a broker’s users (admin, yours, the event bus’s)","description":"`rabbitmq:DescribeRabbitmqUsers` List a broker’s users (admin, yours, the event bus’s).","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqUsers","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rabbitmq.users.create","summary":"Create a user; its password is filed in Secrets","description":"`rabbitmq:CreateRabbitmqUser` Create a user; its password is filed in Secrets. A node applies it within 30 seconds (`applied: true`).","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"},"tags":{"default":"","type":"string","enum":["","monitoring","management","administrator"],"description":"Management UI access: \"\" (messaging only), monitoring, management or administrator"},"configure":{"default":".*","type":"string","maxLength":512,"description":"Regex over the names of the queues and exchanges it may declare or delete on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"},"write":{"default":".*","type":"string","maxLength":512,"description":"Regex over the names of the exchanges and queues it may publish to on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"},"read":{"default":".*","type":"string","maxLength":512,"description":"Regex over the names of the queues it may consume from on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:CreateRabbitmqUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/users/{userName}":{"patch":{"operationId":"rabbitmq.users.update","summary":"Change a user’s tags or permissions","description":"`rabbitmq:UpdateRabbitmqUser` Change a user’s tags or permissions.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"string","enum":["","monitoring","management","administrator"],"description":"Management UI access: \"\" (messaging only), monitoring, management or administrator"},"configure":{"type":"string","maxLength":512,"description":"Regex over the names of the queues and exchanges it may declare or delete on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"},"write":{"type":"string","maxLength":512,"description":"Regex over the names of the exchanges and queues it may publish to on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"},"read":{"type":"string","maxLength":512,"description":"Regex over the names of the queues it may consume from on vhost \"/\" (\"\" = none, \".*\" = all, \"^orders\\.\" = a prefix)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:UpdateRabbitmqUser","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"rabbitmq.users.delete","summary":"Delete a user and its secret","description":"`rabbitmq:DeleteRabbitmqUser` Delete a user and its secret.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DeleteRabbitmqUser","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/brokers/{id}/users/{userName}/rotate-password":{"post":{"operationId":"rabbitmq.users.rotate-password","summary":"Replace a user’s password with a new Secrets version","description":"`rabbitmq:RotateRabbitmqUserPassword` Replace a user’s password with a new Secrets version. A node applies it within 30 seconds; the old password stops working then (RabbitMQ keeps one per user). Redeploy the apps that use it.","tags":["RabbitMQ"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}},{"name":"userName","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_.-]{0,63}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:RotateRabbitmqUserPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/ca-bundle":{"get":{"operationId":"rabbitmq.brokers.ca-bundle","summary":"The platform CA (PEM) the brokers’ certificates chain to","description":"`rabbitmq:DescribeRabbitmqBrokers` The platform CA (PEM) the brokers’ certificates chain to.","tags":["RabbitMQ"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqBrokers","x-ews-mutates":false,"x-ews-sensitive":false}},"/rabbitmq/api/exports":{"get":{"operationId":"rabbitmq.exports.list","summary":"List exports, optionally of one broker","description":"`rabbitmq:DescribeRabbitmqExports` List exports, optionally of one broker.","tags":["RabbitMQ"],"parameters":[{"name":"brokerId","in":"query","required":false,"schema":{"type":"string","pattern":"^rmq-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqExports","x-ews-mutates":false,"x-ews-sensitive":false}},"/rabbitmq/api/exports/{exportId}":{"get":{"operationId":"rabbitmq.exports.get","summary":"One export: state, counts, size, SHA-256","description":"`rabbitmq:DescribeRabbitmqExports` One export: state, counts, size, SHA-256.","tags":["RabbitMQ"],"parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string","pattern":"^rmd-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqExports","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"rabbitmq.exports.delete","summary":"Delete an export and its stored copy","description":"`rabbitmq:DeleteRabbitmqExport` Delete an export and its stored copy.","tags":["RabbitMQ"],"parameters":[{"name":"exportId","in":"path","required":true,"schema":{"type":"string","pattern":"^rmd-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DeleteRabbitmqExport","x-ews-mutates":true,"x-ews-sensitive":false}},"/rabbitmq/api/node-types":{"get":{"operationId":"rabbitmq.brokers.node-types","summary":"The machine types a node can run on, with price and stock","description":"`rabbitmq:DescribeRabbitmqBrokers` The machine types a node can run on, with price and stock.","tags":["RabbitMQ"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rabbitmq:DescribeRabbitmqBrokers","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/branches/{branchId}":{"get":{"operationId":"rds.branches.get","summary":"One branch: status, data as of, masking, connection, create time","description":"`rds:DescribeDBBranches` One branch: status, data as of, masking, connection, create time.","tags":["Postgres"],"parameters":[{"name":"branchId","in":"path","required":true,"schema":{"type":"string","pattern":"^ewbr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Branch id (ewbr-…)"},"parentDbInstanceId":{"type":"string","description":"Database the branch is of"},"name":{"type":"string","description":"Branch name"},"status":{"type":"string","enum":["queued","creating","available","deleting","deleted","failed"],"description":"State of the branch"},"origin":{"type":"string","enum":["base","time"],"description":"base: a clone of the pool's base; time: restored to recoveryTargetTime"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment asked for, for origin time"},"dataAsOf":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the branch's data is from"},"masked":{"type":"boolean","description":"Whether masking rules were applied to its data"},"maskRuleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Masking rules applied"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the branch is deleted; null for a pull-request branch, which lives with its pull request"},"source":{"type":"string","enum":["api","pull_request"],"description":"Asked for through the API or console, or made for a pull request"},"pullRequest":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull request number"}},"required":["gitRepositoryId","number"],"additionalProperties":false},{"type":"null"}],"description":"The pull request it was made for; null otherwise"},"connection":{"type":"object","properties":{"host":{"description":"Host to connect to; null until the branch pool has one","type":["string","null"]},"port":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Port of the branch; null until it is assigned"},"database":{"type":"string","description":"Database to connect to"},"user":{"type":"string","description":"The master user of the parent database"},"secretName":{"type":"string","description":"Secrets entry holding every login role's password on the branch"},"url":{"description":"postgres:// URL without the password; null while host or port is unknown","type":["string","null"]}},"required":["host","port","database","user","secretName","url"],"additionalProperties":false,"description":"Where to connect"},"usedBytes":{"description":"Bytes written to the branch since it was cut, as last reported","type":["number","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was asked for"},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it became available"},"createTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Request to available, milliseconds"},"agentTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Time the branch machine spent creating it, milliseconds"}},"required":["id","parentDbInstanceId","name","status","origin","recoveryTargetTime","dataAsOf","masked","maskRuleCount","expiresAt","source","pullRequest","connection","usedBytes","error","requestedAt","availableAt","createTookMs","agentTookMs"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBBranches","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"rds.branches.modify","summary":"Set when the branch is deleted (hours from now, at most 720)","description":"`rds:ModifyDBBranch` Set when the branch is deleted (hours from now, at most 720).","tags":["Postgres"],"parameters":[{"name":"branchId","in":"path","required":true,"schema":{"type":"string","pattern":"^ewbr-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ttlHours":{"type":"integer","minimum":1,"maximum":720,"description":"Hours from now until the branch is deleted"}},"required":["ttlHours"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Branch id (ewbr-…)"},"parentDbInstanceId":{"type":"string","description":"Database the branch is of"},"name":{"type":"string","description":"Branch name"},"status":{"type":"string","enum":["queued","creating","available","deleting","deleted","failed"],"description":"State of the branch"},"origin":{"type":"string","enum":["base","time"],"description":"base: a clone of the pool's base; time: restored to recoveryTargetTime"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment asked for, for origin time"},"dataAsOf":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the branch's data is from"},"masked":{"type":"boolean","description":"Whether masking rules were applied to its data"},"maskRuleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Masking rules applied"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the branch is deleted; null for a pull-request branch, which lives with its pull request"},"source":{"type":"string","enum":["api","pull_request"],"description":"Asked for through the API or console, or made for a pull request"},"pullRequest":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull request number"}},"required":["gitRepositoryId","number"],"additionalProperties":false},{"type":"null"}],"description":"The pull request it was made for; null otherwise"},"connection":{"type":"object","properties":{"host":{"description":"Host to connect to; null until the branch pool has one","type":["string","null"]},"port":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Port of the branch; null until it is assigned"},"database":{"type":"string","description":"Database to connect to"},"user":{"type":"string","description":"The master user of the parent database"},"secretName":{"type":"string","description":"Secrets entry holding every login role's password on the branch"},"url":{"description":"postgres:// URL without the password; null while host or port is unknown","type":["string","null"]}},"required":["host","port","database","user","secretName","url"],"additionalProperties":false,"description":"Where to connect"},"usedBytes":{"description":"Bytes written to the branch since it was cut, as last reported","type":["number","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was asked for"},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it became available"},"createTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Request to available, milliseconds"},"agentTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Time the branch machine spent creating it, milliseconds"}},"required":["id","parentDbInstanceId","name","status","origin","recoveryTargetTime","dataAsOf","masked","maskRuleCount","expiresAt","source","pullRequest","connection","usedBytes","error","requestedAt","availableAt","createTookMs","agentTookMs"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBBranch","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"rds.branches.delete","summary":"Delete a branch and what was written to it","description":"`rds:DeleteDBBranch` Delete a branch and what was written to it.","tags":["Postgres"],"parameters":[{"name":"branchId","in":"path","required":true,"schema":{"type":"string","pattern":"^ewbr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Branch id"},"status":{"type":"string","enum":["queued","creating","available","deleting","deleted","failed"],"description":"deleting while it is removed"}},"required":["id","status"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteDBBranch","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/branches/{branchId}/credentials":{"get":{"operationId":"rds.branches.get-credentials","summary":"The branch's passwords (every login role) and a DATABASE_URL for its master user","description":"`rds:GetDBBranchCredentials` The branch's passwords (every login role) and a DATABASE_URL for its master user.","tags":["Postgres"],"parameters":[{"name":"branchId","in":"path","required":true,"schema":{"type":"string","pattern":"^ewbr-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"host":{"description":"Host to connect to; null until the branch pool has one","type":["string","null"]},"port":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Port of the branch; null until it is assigned"},"database":{"type":"string","description":"Database to connect to"},"user":{"type":"string","description":"The master user of the parent database"},"secretName":{"type":"string","description":"Secrets entry holding every login role's password on the branch"},"url":{"description":"postgres:// URL without the password; null while host or port is unknown","type":["string","null"]},"passwords":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Every login role's password on the branch, by role name"},"databaseUrl":{"description":"postgres:// URL with the master password; null while host or port is unknown","type":["string","null"]}},"required":["host","port","database","user","secretName","url","passwords","databaseUrl"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:GetDBBranchCredentials","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/ca-bundle":{"get":{"operationId":"rds.ca-bundle.download","summary":"Download the CA bundle to use with sslmode=verify-full","description":"`rds:DescribeDBInstances` Download the CA bundle to use with sslmode=verify-full. One CA per installation, so the same file for every database in every org — it is not scoped to an instance on purpose.","tags":["Postgres"],"responses":{"200":{"description":"Raw bytes with their own content type","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances":{"get":{"operationId":"rds.instances.list","summary":"List database instances","description":"`rds:DescribeDBInstances` List database instances.","tags":["Postgres"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"description":"Only databases in this state","type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"]}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many (default 100)","type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rds.instances.create","summary":"Create a database instance","description":"`rds:CreateDBInstance` Create a database instance.","tags":["Postgres"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"identifier":{"type":"string","minLength":3,"maxLength":48,"pattern":"^[a-z][a-z0-9-]*[a-z0-9]$","description":"Name of the database, unique within the organization"},"instanceClass":{"type":"string","minLength":1,"maxLength":32,"description":"Instance type of every node, from server-types (e.g. performance-2; the provider’s own names are still accepted, deprecated); a cluster needs one with at least 8 GiB of memory"},"engineVersion":{"description":"PostgreSQL major (e.g. 17, installed at its current pinned minor) or one of its pinned minors (e.g. 17.11); omitted: PostgreSQL 17","type":"string","maxLength":16,"pattern":"^(18|17|16|15|18\\.7|17\\.12|17\\.11|16\\.16|15\\.20)$"},"topology":{"default":"single","description":"single: one node (the default); cluster: three nodes with automatic failover","type":"string","enum":["single","cluster"]},"dbName":{"default":"appdb","description":"Name of the database created inside the server; appdb when omitted","type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z][a-z0-9_]*$"},"masterUsername":{"default":"admin","description":"Name of the master role, whose password is filed in Secrets; admin when omitted","type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z][a-z0-9_]*$"},"allocatedStorageGib":{"default":20,"description":"Size of each node's data volume in GiB; 20 when omitted","type":"integer","minimum":10,"maximum":4000},"maxAllocatedStorageGib":{"description":"Autoscaling ceiling in GiB, not below allocatedStorageGib; null or omitted leaves automatic growth off","anyOf":[{"type":"integer","minimum":10,"maximum":10000},{"type":"null"}]},"backupRetentionDays":{"default":7,"description":"Days backups are kept for restores; 0 turns scheduled backups off; 7 when omitted","type":"integer","minimum":0,"maximum":35},"tags":{"description":"Tags (key → value) for the database; its nodes' volumes inherit them","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"kmsKeyId":{"description":"KMS key that wraps every node volume's key (needs kms:Encrypt on it); omitted: the platform key","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"publiclyAccessible":{"default":false,"description":"Whether the database answers on the internet; off by default: reachable only from its VPC","type":"boolean"},"deletionProtection":{"default":false,"description":"Refuse delete until it is switched off again; off by default","type":"boolean"},"requireTls":{"default":true,"description":"Refuse clients that do not use TLS, on both ports; on by default","type":"boolean"},"replicationMode":{"description":"Cluster only. sync (the default for a cluster): a commit waits for one standby, so a failover loses nothing acknowledged; async: lower commit latency","type":"string","enum":["async","sync"]},"zonePlacement":{"description":"Cluster only, fixed after creation. spread (the default for a cluster): members round-robin over the region's zones; single: all in availabilityZoneId","type":"string","enum":["spread","single"]},"logicalReplication":{"default":false,"description":"wal_level = logical from the first start, for CDC and publications; off by default","type":"boolean"},"availabilityZoneId":{"description":"Zone of a single node or of a single-placement cluster, e.g. de1b; omitted: the region's default zone","type":"string","pattern":"^[a-z]+[0-9]+[a-z]$"},"vpcId":{"description":"VPC the database joins; omitted: the organization's default VPC for the region","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"subnetId":{"description":"Subnet of that VPC to place the database in; omitted: the VPC's whole range","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"When the zone is sold out of the type, another zone of the region may be used"},"equivalentTypes":{"type":"boolean","description":"When the type is sold out, an equivalent one may be bought: same CPU architecture, same CPU class or better, at least the vCPUs and memory, at most 1.25× the price plus 5 cents; billed as what was bought"}},"required":["otherZones","equivalentTypes"],"description":"What a create may fall back to when the provider is out of stock"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"When the type is sold out where it goes and no fallback applies: fail at once (default), or wait as waiting-for-capacity (nothing built or billed) until it is back"},"capacityMaxWaitHours":{"type":"integer","minimum":1,"maximum":168,"description":"With onStockOut wait: give up after this many hours (1–168, default 24)"}},"required":["identifier","instanceClass"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}":{"get":{"operationId":"rds.instances.get","summary":"Describe one database instance","description":"`rds:DescribeDBInstances` Describe one database instance. `encryption.storage` is \"luks2\" (every node's data volume is LUKS2, opened at boot with a per-volume key from KMS) or \"none\" for a database created before disk encryption; those keep plain volumes and move by restoring into a new database. `encryption.backups` is \"aes-256-cbc\" (pgBackRest, encrypted on the database machine before upload) or \"none\" for a database created before backup encryption.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"},"placement":{"type":"object","properties":{"zones":{"type":"array","items":{"type":"string"},"description":"Zones the nodes are in"},"survivesLossOf":{"type":"array","items":{"type":"string"},"description":"Zones the database keeps serving without (a majority of core nodes is elsewhere)"},"leaderZoneId":{"description":"Zone of the node that leads now; null when no node is the leader","type":["string","null"]},"nodes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Node name"},"role":{"type":"string","enum":["primary","replica"],"description":"Role as last observed"},"zoneId":{"description":"Zone of the node","type":["string","null"]}},"required":["name","role","zoneId"],"additionalProperties":false},"description":"Each node, its role and zone"}},"required":["zones","survivesLossOf","leaderZoneId","nodes"],"additionalProperties":false,"description":"Where the machines are and what losing a zone does"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption","placement"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"rds.instances.delete","summary":"Delete a database instance and its machines","description":"`rds:DeleteDBInstance` Delete a database instance and its machines. Refused with 400 while deletion protection is enabled. With finalBackup=true a full backup is taken first; if it fails nothing is deleted. The database then stays as `retained` (no machines, backups kept) until its retention period ends, and can be restored from. Deleting a `retained` database removes its backups at once.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"finalBackup","in":"query","required":false,"schema":{"description":"true: take a full backup first and keep the backups for the retention period, as a `retained` database that can be restored from","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id"},"status":{"type":"string","const":"deleting","description":"The database is being removed"},"finalBackup":{"type":"boolean","description":"Whether a final backup is taken first and the database kept as retained"}},"required":["id","status","finalBackup"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteDBInstance","x-ews-mutates":true,"x-ews-sensitive":false},"patch":{"operationId":"rds.instances.start+stop+reboot","summary":"start, stop, reboot — selected by the request body","description":"Several operations share this method and path; the handler picks one from the body.\n- `rds.instances.start` — `rds:StartDBInstance` Start a stopped database instance.\n- `rds.instances.stop` — `rds:StopDBInstance` Stop a running database instance.\n- `rds.instances.reboot` — `rds:RebootDBInstance` Reboot a database instance.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"start"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"stop"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"reboot"}},"required":["action"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id"},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"starting after start, stopping after stop; after reboot rebooting for a single node, its current status for a cluster"}},"required":["id","status"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:StartDBInstance","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-operations":["rds.instances.start","rds.instances.stop","rds.instances.reboot"]}},"/rds/api/instances/{id}/backup-settings":{"patch":{"operationId":"rds.instances.modify-backup-settings","summary":"Change backup retention or the daily backup window","description":"`rds:ModifyDBInstance` Change backup retention or the daily backup window.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"backupRetentionDays":{"description":"Days backups are kept; 0 turns scheduled backups off; omitted: unchanged","type":"integer","minimum":0,"maximum":35},"backupWindow":{"description":"When the daily backup runs, HH:MM-HH:MM (only the start is used; 03:00-04:00 by default); omitted: unchanged","type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d-([01]\\d|2[0-3]):[0-5]\\d$"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM; null: the default 03:00-04:00","type":["string","null"]}},"required":["backupRetentionDays","backupWindow"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/backups":{"get":{"operationId":"rds.backups.list","summary":"List backups and the recoverable window","description":"`rds:ListBackups` List backups and the recoverable window.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"backups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Backup id"},"dbInstanceId":{"type":"string","description":"Database the backup is of"},"orgId":{"type":"string","description":"Organization that owns the database"},"type":{"type":"string","enum":["full","differential","incremental"],"description":"full copies every file; the others what changed since an earlier backup"},"status":{"type":"string","enum":["running","completed","failed","expired"],"description":"expired: aged out of the retention window and no longer in the repository"},"label":{"description":"Name of the backup, e.g. 20260826-030000F; null until it has finished","type":["string","null"]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the backup started (or was requested)"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished; null while running"},"sizeBytes":{"description":"Size of the database as backed up, bytes","type":["number","null"]},"repoSizeBytes":{"description":"Space it takes in the backup repository, bytes: what is billed","type":["number","null"]},"walStart":{"description":"First WAL segment the backup needs","type":["string","null"]},"walStop":{"description":"Last WAL segment the backup needs","type":["string","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"keptUntilDeleted":{"type":"boolean","description":"Taken by hand and kept until deleted, not expired with the retention window"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the record was created"}},"required":["id","dbInstanceId","orgId","type","status","label","startedAt","finishedAt","sizeBytes","repoSizeBytes","walStart","walStop","error","keptUntilDeleted","createdAt"],"additionalProperties":false},"description":"The newest backups, newest first"},"recoveryWindow":{"anyOf":[{"type":"object","properties":{"earliest":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Earliest moment a restore can name"},"latest":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Latest moment a restore can name"}},"required":["earliest","latest"],"additionalProperties":false},{"type":"null"}],"description":"The moments a point-in-time restore can name; null: none yet"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"agentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database's machines last asked for backup work; null: never"},"retentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM","type":["string","null"]},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished"},"keepsByHand":{"type":"boolean","description":"A backup taken by hand is kept until it is deleted (at most 20)"}},"required":["backups","recoveryWindow","backupsEnabled","agentSeenAt","retentionDays","backupWindow","lastBackupAt","keepsByHand"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ListBackups","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rds.backups.create","summary":"Take a backup now","description":"`rds:CreateBackup` Take a backup now. On a database whose nodes run backup poller 3 (`keepsByHand` in the list), the backup is kept until you delete it, at most 20 per database; otherwise it follows the retention window.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"backup":{"type":"object","properties":{"id":{"type":"string","description":"Backup id"},"dbInstanceId":{"type":"string","description":"Database the backup is of"},"orgId":{"type":"string","description":"Organization that owns the database"},"type":{"type":"string","enum":["full","differential","incremental"],"description":"full copies every file; the others what changed since an earlier backup"},"status":{"type":"string","enum":["running","completed","failed","expired"],"description":"expired: aged out of the retention window and no longer in the repository"},"label":{"description":"Name of the backup, e.g. 20260826-030000F; null until it has finished","type":["string","null"]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the backup started (or was requested)"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished; null while running"},"sizeBytes":{"description":"Size of the database as backed up, bytes","type":["number","null"]},"repoSizeBytes":{"description":"Space it takes in the backup repository, bytes: what is billed","type":["number","null"]},"walStart":{"description":"First WAL segment the backup needs","type":["string","null"]},"walStop":{"description":"Last WAL segment the backup needs","type":["string","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"keptUntilDeleted":{"type":"boolean","description":"Taken by hand and kept until deleted, not expired with the retention window"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the record was created"}},"required":["id","dbInstanceId","orgId","type","status","label","startedAt","finishedAt","sizeBytes","repoSizeBytes","walStart","walStop","error","keptUntilDeleted","createdAt"],"additionalProperties":false,"description":"The backup requested"},"state":{"type":"string","const":"requested","description":"Recorded; a database node picks the request up and reports back"}},"required":["backup","state"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateBackup","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/backups/{backupId}":{"delete":{"operationId":"rds.backups.delete","summary":"Delete a backup taken by hand that is kept until deleted","description":"`rds:DeleteBackup` Delete a backup taken by hand that is kept until deleted. Older than the retention window, it is expired at once and the node removes it from the repository within a minute; inside the window it follows the window from now on. A backup that follows the window anyway is refused with 409.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"backupId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"backupId":{"type":"string","description":"The backup"},"expired":{"type":"boolean","description":"true: removed now; false: it now follows the retention window"}},"required":["backupId","expired"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteBackup","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/branch-pool":{"patch":{"operationId":"rds.branches.set-pool","summary":"How old the pool base may be before a new branch refreshes it","description":"`rds:ModifyDBBranchSettings` How old the pool base may be before a new branch refreshes it.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"staleAfterHours":{"type":"integer","minimum":0,"maximum":720,"description":"A branch asked for on an older base refreshes it first; 0: always"}},"required":["staleAfterHours"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Branch pool id"},"status":{"type":"string","enum":["building","preparing","available","refreshing","deleting","failed"],"description":"State of the pool"},"host":{"anyOf":[{"type":"object","properties":{"dbInstanceId":{"type":"string","description":"Database id of the pool machine"},"identifier":{"type":"string","description":"Its name"},"instanceClass":{"type":"string","description":"Its instance type"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its storage, GiB"},"status":{"type":"string","description":"Its state"}},"required":["dbInstanceId","identifier","instanceClass","allocatedStorageGib","status"],"additionalProperties":false},{"type":"null"}],"description":"The machine the branches run on; null before it exists"},"baseRestoredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the base's data is from"},"maskedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the base was masked"},"maskRulesCurrent":{"type":"boolean","description":"False when the masking rules changed since: the next branch refreshes the base"},"staleAfterHours":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"A branch asked for on an older base refreshes it first; 0: always"},"refreshDue":{"description":"Why the next branch will refresh the base first; null when it will not","type":["string","null"]},"operation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Operation id"},"kind":{"type":"string","enum":["prepare-base","refresh-base"],"description":"What is being done"},"status":{"type":"string","enum":["pending","running"],"description":"Waiting or running"},"requestedAt":{"type":"string","description":"When it was asked for"},"claimedAt":{"description":"When the pool machine took it up","type":"string"},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tries so far"},"rulesHash":{"description":"Fingerprint of the masking rules the base is masked with","type":["string","null"]}},"required":["id","kind","status","requestedAt","attempts"],"additionalProperties":false},{"type":"null"}],"description":"The pool's operation in progress; null: none"},"usage":{"anyOf":[{"type":"object","properties":{"poolSizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of the pool storage, bytes"},"poolFreeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Free, bytes"},"baseUsedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Taken by the base, bytes"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Branch id"},"usedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Bytes written since the clone"},"running":{"type":"boolean","description":"Whether its server runs"}},"required":["id","usedBytes","running"],"additionalProperties":false},"description":"Each branch"}},"required":["poolSizeBytes","poolFreeBytes","baseUsedBytes","branches"],"additionalProperties":false},{"type":"null"}],"description":"Space, as the pool machine last reported; null: not reported"},"usageReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When usage was reported"},"lastError":{"description":"Why the pool last failed; null otherwise","type":["string","null"]},"emptySince":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Since when the pool holds no branch; null while it holds some"}},"required":["id","status","host","baseRestoredAt","maskedAt","maskRulesCurrent","staleAfterHours","refreshDue","operation","usage","usageReportedAt","lastError","emptySince"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBBranchSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/branch-pool/refresh":{"post":{"operationId":"rds.branches.refresh-pool","summary":"Restore the latest backup into a new pool base and mask it; existing branches keep theirs","description":"`rds:ModifyDBBranchSettings` Restore the latest backup into a new pool base and mask it; existing branches keep theirs.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"pool":{"type":"object","properties":{"id":{"type":"string","description":"Branch pool id"},"status":{"type":"string","enum":["building","preparing","available","refreshing","deleting","failed"],"description":"State of the pool"},"host":{"anyOf":[{"type":"object","properties":{"dbInstanceId":{"type":"string","description":"Database id of the pool machine"},"identifier":{"type":"string","description":"Its name"},"instanceClass":{"type":"string","description":"Its instance type"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its storage, GiB"},"status":{"type":"string","description":"Its state"}},"required":["dbInstanceId","identifier","instanceClass","allocatedStorageGib","status"],"additionalProperties":false},{"type":"null"}],"description":"The machine the branches run on; null before it exists"},"baseRestoredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the base's data is from"},"maskedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the base was masked"},"maskRulesCurrent":{"type":"boolean","description":"False when the masking rules changed since: the next branch refreshes the base"},"staleAfterHours":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"A branch asked for on an older base refreshes it first; 0: always"},"refreshDue":{"description":"Why the next branch will refresh the base first; null when it will not","type":["string","null"]},"operation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Operation id"},"kind":{"type":"string","enum":["prepare-base","refresh-base"],"description":"What is being done"},"status":{"type":"string","enum":["pending","running"],"description":"Waiting or running"},"requestedAt":{"type":"string","description":"When it was asked for"},"claimedAt":{"description":"When the pool machine took it up","type":"string"},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tries so far"},"rulesHash":{"description":"Fingerprint of the masking rules the base is masked with","type":["string","null"]}},"required":["id","kind","status","requestedAt","attempts"],"additionalProperties":false},{"type":"null"}],"description":"The pool's operation in progress; null: none"},"usage":{"anyOf":[{"type":"object","properties":{"poolSizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of the pool storage, bytes"},"poolFreeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Free, bytes"},"baseUsedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Taken by the base, bytes"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Branch id"},"usedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Bytes written since the clone"},"running":{"type":"boolean","description":"Whether its server runs"}},"required":["id","usedBytes","running"],"additionalProperties":false},"description":"Each branch"}},"required":["poolSizeBytes","poolFreeBytes","baseUsedBytes","branches"],"additionalProperties":false},{"type":"null"}],"description":"Space, as the pool machine last reported; null: not reported"},"usageReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When usage was reported"},"lastError":{"description":"Why the pool last failed; null otherwise","type":["string","null"]},"emptySince":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Since when the pool holds no branch; null while it holds some"}},"required":["id","status","host","baseRestoredAt","maskedAt","maskRulesCurrent","staleAfterHours","refreshDue","operation","usage","usageReportedAt","lastError","emptySince"],"additionalProperties":false,"description":"The pool, now preparing or refreshing"},"branches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Branches the pool holds"}},"required":["pool","branches"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBBranchSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/branch-settings":{"get":{"operationId":"rds.branches.get-settings","summary":"Masking rules and pull-request branches of a database","description":"`rds:DescribeDBBranches` Masking rules and pull-request branches of a database.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"masking":{"type":"array","items":{"type":"object","properties":{"database":{"type":"string","description":"Database inside the instance"},"schema":{"type":"string","description":"Schema of the table"},"table":{"type":"string","description":"Table"},"column":{"type":"string","description":"Column rewritten"},"method":{"type":"string","enum":["null","redact","hash","email","phone","name"],"description":"How the column is rewritten"}},"required":["database","schema","table","column","method"],"additionalProperties":false},"description":"Columns rewritten in the pool base before any branch sees it"},"pullRequests":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository whose pull requests get a branch"},"targetBranches":{"type":"array","items":{"type":"string"},"description":"Pull requests into these branches; empty: the repository's default branch"}},"required":["gitRepositoryId","targetBranches"],"additionalProperties":false},{"type":"null"}],"description":"A branch per pull request; null: off"}},"required":["masking","pullRequests"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBBranches","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"rds.branches.set-settings","summary":"Set the masking rules and pull-request branches (replaces both)","description":"`rds:ModifyDBBranchSettings` Set the masking rules and pull-request branches (replaces both). No branch is served unmasked: changed rules make the next branch refresh the pool base first. A rule for a column that does not exist is skipped and reported in the activity log.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"masking":{"default":[],"description":"Columns rewritten in the pool base before any branch sees it; none when omitted","maxItems":200,"type":"array","items":{"type":"object","properties":{"database":{"type":"string","minLength":1,"maxLength":63,"description":"Database inside the instance"},"schema":{"default":"public","type":"string","minLength":1,"maxLength":63},"table":{"type":"string","minLength":1,"maxLength":63},"column":{"type":"string","minLength":1,"maxLength":63},"method":{"type":"string","enum":["null","redact","hash","email","phone","name"],"description":"null; redact (REDACTED); hash (md5, joins still match); email (user-<hash>@example.invalid); phone (+00…); name (Person <hash>)"}},"required":["database","table","column","method"]}},"pullRequests":{"default":null,"description":"A branch per pull request of a Git repository; null or omitted turns it off","anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deutsche Cloud Git repository whose pull requests get a branch"},"targetBranches":{"default":[],"description":"Pull requests into these branches; empty: the repository's default branch","maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["gitRepositoryId"]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"masking":{"type":"array","items":{"type":"object","properties":{"database":{"type":"string","description":"Database inside the instance"},"schema":{"type":"string","description":"Schema of the table"},"table":{"type":"string","description":"Table"},"column":{"type":"string","description":"Column rewritten"},"method":{"type":"string","enum":["null","redact","hash","email","phone","name"],"description":"How the column is rewritten"}},"required":["database","schema","table","column","method"],"additionalProperties":false},"description":"Columns rewritten in the pool base before any branch sees it"},"pullRequests":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository whose pull requests get a branch"},"targetBranches":{"type":"array","items":{"type":"string"},"description":"Pull requests into these branches; empty: the repository's default branch"}},"required":["gitRepositoryId","targetBranches"],"additionalProperties":false},{"type":"null"}],"description":"A branch per pull request; null: off"}},"required":["masking","pullRequests"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBBranchSettings","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/branches":{"get":{"operationId":"rds.branches.list","summary":"A database's branches with where to connect, and its branch pool: machine, base age, masking, operation, space per branch","description":"`rds:DescribeDBBranches` A database's branches with where to connect, and its branch pool: machine, base age, masking, operation, space per branch.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"includeDeleted","in":"query","required":false,"schema":{"description":"Include deleted branches","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"pool":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Branch pool id"},"status":{"type":"string","enum":["building","preparing","available","refreshing","deleting","failed"],"description":"State of the pool"},"host":{"anyOf":[{"type":"object","properties":{"dbInstanceId":{"type":"string","description":"Database id of the pool machine"},"identifier":{"type":"string","description":"Its name"},"instanceClass":{"type":"string","description":"Its instance type"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its storage, GiB"},"status":{"type":"string","description":"Its state"}},"required":["dbInstanceId","identifier","instanceClass","allocatedStorageGib","status"],"additionalProperties":false},{"type":"null"}],"description":"The machine the branches run on; null before it exists"},"baseRestoredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the base's data is from"},"maskedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the base was masked"},"maskRulesCurrent":{"type":"boolean","description":"False when the masking rules changed since: the next branch refreshes the base"},"staleAfterHours":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"A branch asked for on an older base refreshes it first; 0: always"},"refreshDue":{"description":"Why the next branch will refresh the base first; null when it will not","type":["string","null"]},"operation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Operation id"},"kind":{"type":"string","enum":["prepare-base","refresh-base"],"description":"What is being done"},"status":{"type":"string","enum":["pending","running"],"description":"Waiting or running"},"requestedAt":{"type":"string","description":"When it was asked for"},"claimedAt":{"description":"When the pool machine took it up","type":"string"},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Tries so far"},"rulesHash":{"description":"Fingerprint of the masking rules the base is masked with","type":["string","null"]}},"required":["id","kind","status","requestedAt","attempts"],"additionalProperties":false},{"type":"null"}],"description":"The pool's operation in progress; null: none"},"usage":{"anyOf":[{"type":"object","properties":{"poolSizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of the pool storage, bytes"},"poolFreeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Free, bytes"},"baseUsedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Taken by the base, bytes"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Branch id"},"usedBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Bytes written since the clone"},"running":{"type":"boolean","description":"Whether its server runs"}},"required":["id","usedBytes","running"],"additionalProperties":false},"description":"Each branch"}},"required":["poolSizeBytes","poolFreeBytes","baseUsedBytes","branches"],"additionalProperties":false},{"type":"null"}],"description":"Space, as the pool machine last reported; null: not reported"},"usageReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When usage was reported"},"lastError":{"description":"Why the pool last failed; null otherwise","type":["string","null"]},"emptySince":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Since when the pool holds no branch; null while it holds some"}},"required":["id","status","host","baseRestoredAt","maskedAt","maskRulesCurrent","staleAfterHours","refreshDue","operation","usage","usageReportedAt","lastError","emptySince"],"additionalProperties":false},{"type":"null"}],"description":"The branch pool; null before the first branch"},"branches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Branch id (ewbr-…)"},"parentDbInstanceId":{"type":"string","description":"Database the branch is of"},"name":{"type":"string","description":"Branch name"},"status":{"type":"string","enum":["queued","creating","available","deleting","deleted","failed"],"description":"State of the branch"},"origin":{"type":"string","enum":["base","time"],"description":"base: a clone of the pool's base; time: restored to recoveryTargetTime"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment asked for, for origin time"},"dataAsOf":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the branch's data is from"},"masked":{"type":"boolean","description":"Whether masking rules were applied to its data"},"maskRuleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Masking rules applied"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the branch is deleted; null for a pull-request branch, which lives with its pull request"},"source":{"type":"string","enum":["api","pull_request"],"description":"Asked for through the API or console, or made for a pull request"},"pullRequest":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull request number"}},"required":["gitRepositoryId","number"],"additionalProperties":false},{"type":"null"}],"description":"The pull request it was made for; null otherwise"},"connection":{"type":"object","properties":{"host":{"description":"Host to connect to; null until the branch pool has one","type":["string","null"]},"port":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Port of the branch; null until it is assigned"},"database":{"type":"string","description":"Database to connect to"},"user":{"type":"string","description":"The master user of the parent database"},"secretName":{"type":"string","description":"Secrets entry holding every login role's password on the branch"},"url":{"description":"postgres:// URL without the password; null while host or port is unknown","type":["string","null"]}},"required":["host","port","database","user","secretName","url"],"additionalProperties":false,"description":"Where to connect"},"usedBytes":{"description":"Bytes written to the branch since it was cut, as last reported","type":["number","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was asked for"},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it became available"},"createTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Request to available, milliseconds"},"agentTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Time the branch machine spent creating it, milliseconds"}},"required":["id","parentDbInstanceId","name","status","origin","recoveryTargetTime","dataAsOf","masked","maskRuleCount","expiresAt","source","pullRequest","connection","usedBytes","error","requestedAt","availableAt","createTookMs","agentTookMs"],"additionalProperties":false},"description":"The branches of the database"}},"required":["pool","branches"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBBranches","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rds.branches.create","summary":"Cut a branch: a ZFS clone of the masked pool base, or a restore to a second","description":"`rds:CreateDBBranch` Cut a branch: a ZFS clone of the masked pool base, or a restore to a second. The first branch of a database builds its branch pool (a restore of the latest backup onto one machine, minutes); later ones take seconds. A base older than the pool’s staleAfterHours (24) or masked with other rules is refreshed first. Every login role gets a new password on the branch (get-credentials).","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-z0-9][a-z0-9-]*$","description":"Branch name: lowercase letters, digits and dashes (pr-42, alice-test)"},"recoveryTargetTime":{"description":"Branch the database as it was at this second (restored on the pool, minutes); omitted: now, a copy-on-write clone of the pool base (seconds)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"ttlHours":{"description":"Hours until the branch is deleted; default 168 (7 days)","type":"integer","minimum":1,"maximum":720}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"branch":{"type":"object","properties":{"id":{"type":"string","description":"Branch id (ewbr-…)"},"parentDbInstanceId":{"type":"string","description":"Database the branch is of"},"name":{"type":"string","description":"Branch name"},"status":{"type":"string","enum":["queued","creating","available","deleting","deleted","failed"],"description":"State of the branch"},"origin":{"type":"string","enum":["base","time"],"description":"base: a clone of the pool's base; time: restored to recoveryTargetTime"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment asked for, for origin time"},"dataAsOf":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The moment the branch's data is from"},"masked":{"type":"boolean","description":"Whether masking rules were applied to its data"},"maskRuleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Masking rules applied"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the branch is deleted; null for a pull-request branch, which lives with its pull request"},"source":{"type":"string","enum":["api","pull_request"],"description":"Asked for through the API or console, or made for a pull request"},"pullRequest":{"anyOf":[{"type":"object","properties":{"gitRepositoryId":{"type":"string","description":"Git repository"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pull request number"}},"required":["gitRepositoryId","number"],"additionalProperties":false},{"type":"null"}],"description":"The pull request it was made for; null otherwise"},"connection":{"type":"object","properties":{"host":{"description":"Host to connect to; null until the branch pool has one","type":["string","null"]},"port":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Port of the branch; null until it is assigned"},"database":{"type":"string","description":"Database to connect to"},"user":{"type":"string","description":"The master user of the parent database"},"secretName":{"type":"string","description":"Secrets entry holding every login role's password on the branch"},"url":{"description":"postgres:// URL without the password; null while host or port is unknown","type":["string","null"]}},"required":["host","port","database","user","secretName","url"],"additionalProperties":false,"description":"Where to connect"},"usedBytes":{"description":"Bytes written to the branch since it was cut, as last reported","type":["number","null"]},"error":{"description":"Why it failed; null otherwise","type":["string","null"]},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was asked for"},"availableAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it became available"},"createTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Request to available, milliseconds"},"agentTookMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Time the branch machine spent creating it, milliseconds"}},"required":["id","parentDbInstanceId","name","status","origin","recoveryTargetTime","dataAsOf","masked","maskRuleCount","expiresAt","source","pullRequest","connection","usedBytes","error","requestedAt","availableAt","createTookMs","agentTookMs"],"additionalProperties":false,"description":"The branch"},"note":{"description":"What happens before it is available (the pool is built or refreshed first); null: nothing","type":["string","null"]}},"required":["branch","note"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateDBBranch","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/cluster":{"get":{"operationId":"rds.instances.cluster","summary":"Show Patroni cluster membership and replication state","description":"`rds:DescribeDBInstances` Show Patroni cluster membership and replication state.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Member (node) name"},"role":{"type":"string","description":"leader, sync_standby, replica, …; unknown when not reported"},"state":{"type":"string","description":"running, streaming, stopped, …; unknown when not reported"},"lagBytes":{"description":"Replication lag behind the leader, bytes; null for the leader","type":["number","null"]},"host":{"type":"string","description":"The member's address inside the cluster"},"timeline":{"description":"PostgreSQL timeline the member is on","type":["number","null"]},"pendingRestart":{"type":"boolean","description":"A setting changed that takes effect at its next restart"}},"required":["name","role","state","lagBytes","host","timeline","pendingRestart"],"additionalProperties":false}},{"type":"null"}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/data/query":{"post":{"operationId":"rds.data.run-query","summary":"Run one read-only statement in a READ ONLY transaction with a statement timeout","description":"`rds:QueryDatabase` Run one read-only statement in a READ ONLY transaction with a statement timeout.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sql":{"type":"string","minLength":1,"maxLength":20000,"description":"One read-only statement; it runs in a READ ONLY transaction with a 15 s timeout"},"limit":{"default":200,"description":"At most this many rows are returned; 200 when omitted","type":"integer","minimum":1,"maximum":500}},"required":["sql"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Column name"},"type":{"type":"string","description":"PostgreSQL type"}},"required":["name","type"],"additionalProperties":false},"description":"Columns of the result"},"rows":{"type":"array","items":{"type":"array","items":{"type":["string","null"]}},"description":"Rows, each value as text or null"},"truncated":{"type":"boolean","description":"The row limit cut the result"},"durationMs":{"type":"number","description":"Time the statement took, ms"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The row limit applied"}},"required":["columns","rows","truncated","durationMs","limit"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:QueryDatabase","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/instances/{id}/data/relations":{"get":{"operationId":"rds.data.list-relations","summary":"List schemas and tables with size and an estimated row count","description":"`rds:QueryDatabase` List schemas and tables with size and an estimated row count.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"relations":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"string","description":"Schema"},"name":{"type":"string","description":"Table or view name"},"kind":{"type":"string","description":"table, partitioned table, view or materialized view"},"estimatedRows":{"description":"Estimated rows; null: never analysed","type":["number","null"]},"totalBytes":{"type":"number","description":"Size with indexes and TOAST, bytes"},"comment":{"description":"Its comment, cut at 1,000 characters","type":["string","null"]}},"required":["schema","name","kind","estimatedRows","totalBytes","comment"],"additionalProperties":false},"description":"Every table and view outside the system schemas"}},"required":["relations"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:QueryDatabase","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/instances/{id}/data/rows":{"get":{"operationId":"rds.data.read-rows","summary":"One page of a table's rows, plus its column types","description":"`rds:QueryDatabase` One page of a table's rows, plus its column types.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"schema","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":63,"description":"Schema of the table, e.g. public"}},{"name":"table","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":63,"description":"Name of the table"}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"description":"Rows per page; 50 when omitted","type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"description":"Rows to skip, in primary-key order; 0 when omitted","type":"integer","minimum":0,"maximum":1000000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Column name"},"type":{"type":"string","description":"PostgreSQL type"},"notNull":{"type":"boolean","description":"NOT NULL"},"defaultExpr":{"description":"Default expression; null: none","type":["string","null"]},"isPrimaryKey":{"type":"boolean","description":"Part of the primary key"}},"required":["name","type","notNull","defaultExpr","isPrimaryKey"],"additionalProperties":false},"description":"Columns of the table"},"rows":{"type":"array","items":{"type":"array","items":{"type":["string","null"]}},"description":"Rows, each value as text or null"},"rowColumns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Column name"},"type":{"type":"string","description":"PostgreSQL type"}},"required":["name","type"],"additionalProperties":false},"description":"Columns in the order the rows use them"},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Rows skipped"},"hasMore":{"type":"boolean","description":"Another page follows"},"estimatedRows":{"description":"Estimated rows; null: never analysed","type":["number","null"]},"orderedBy":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Columns the rows are ordered by; null: the table has no primary key"}},"required":["columns","rows","rowColumns","offset","hasMore","estimatedRows","orderedBy"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:QueryDatabase","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/instances/{id}/deletion-protection":{"patch":{"operationId":"rds.instances.set-deletion-protection","summary":"Turn deletion protection on or off; while on, delete is refused","description":"`rds:ModifyDBInstance` Turn deletion protection on or off; while on, delete is refused.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true: refuse delete; false: allow it again"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deletionProtection":{"type":"boolean","description":"While true, delete is refused"}},"required":["deletionProtection"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/events":{"get":{"operationId":"rds.instances.events","summary":"The activity stream of a database: the newest events, oldest first","description":"`rds:DescribeDBInstances` The activity stream of a database: the newest events, oldest first.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"since","in":"query","required":false,"schema":{"description":"Only events after this ISO time, for polling; omitted: from the first event","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many events (default 200)","type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Event id"},"orgId":{"type":"string","description":"Organization the event belongs to"},"resourceType":{"type":"string","description":"Kind of resource; db_instance here"},"resourceId":{"type":"string","description":"The database id"},"source":{"type":"string","enum":["control_plane","machine"],"description":"control_plane: a step the platform ran; machine: reported by a node"},"level":{"type":"string","enum":["info","warn","error"],"description":"Severity"},"phase":{"description":"Stage it belongs to, e.g. provision, backup, upgrade","type":["string","null"]},"message":{"type":"string","description":"What happened"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it happened"}},"required":["id","orgId","resourceType","resourceId","source","level","phase","message","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/extensions":{"get":{"operationId":"rds.extensions.list","summary":"List supported extensions with installed and available versions, preload state and whether a restart is pending","description":"`rds:DescribeDBExtensions` List supported extensions with installed and available versions, preload state and whether a restart is pending.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"database","in":"query","required":false,"schema":{"description":"Database inside the instance; omitted: the one created with the instance","type":"string","minLength":1,"maxLength":63}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"database":{"type":"string","description":"Database read"},"databases":{"type":"array","items":{"type":"string"},"description":"Every database on the server"},"topology":{"type":"string","enum":["single","cluster"],"description":"Topology of the database"},"preload":{"type":"object","properties":{"running":{"type":"array","items":{"type":"string"},"description":"Libraries the running server loaded: the ones in effect"},"configured":{"type":"array","items":{"type":"string"},"description":"Libraries configured; differ from running until a restart"}},"required":["running","configured"],"additionalProperties":false,"description":"shared_preload_libraries"},"restartRequired":{"type":"boolean","description":"The preload list changed and waits for a restart"},"extensions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name CREATE EXTENSION takes"},"description":{"type":"string","description":"What it does"},"category":{"type":"string","enum":["ai","search","types","geo","indexing","jobs","monitoring","security","fdw","dev","utility"],"description":"Group it is shown in"},"source":{"type":"string","enum":["contrib","pgdg"],"description":"contrib: ships with PostgreSQL; pgdg: an extra package"},"trusted":{"type":"boolean","description":"Any role with CREATE on the database can create it"},"requires":{"type":"array","items":{"type":"string"},"description":"Extensions it needs, installed with it"},"note":{"description":"What to know before switching it on","type":["string","null"]},"preloadLibrary":{"description":"Library it needs preloaded; null: none","type":["string","null"]},"preloaded":{"description":"That library is loaded now; null: it needs none","type":["boolean","null"]},"singleDatabase":{"type":"boolean","description":"Can live in one database of the server only"},"homeDatabase":{"description":"For a single-database extension: the database it may live in","type":["string","null"]},"available":{"type":"boolean","description":"Installed on the server, so it can be enabled"},"defaultVersion":{"type":"string","description":"Version CREATE EXTENSION installs"},"installedVersion":{"description":"Version enabled in this database; null: not enabled","type":["string","null"]},"schema":{"description":"Schema it lives in","type":["string","null"]},"enabled":{"type":"boolean","description":"Enabled in this database"},"restartPending":{"type":"boolean","description":"Its library was added and loads at the next restart"}},"required":["name","description","category","source","trusted","requires","note","preloadLibrary","preloaded","singleDatabase","homeDatabase","available","defaultVersion","installedVersion","schema","enabled","restartPending"],"additionalProperties":false},"description":"Every supported extension"}},"required":["database","databases","topology","preload","restartRequired","extensions"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBExtensions","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/extensions/{extension}/disable":{"post":{"operationId":"rds.extensions.disable","summary":"DROP EXTENSION; 409 listing dependent objects unless cascade is true","description":"`rds:DisableDBExtension` DROP EXTENSION; 409 listing dependent objects unless cascade is true.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"extension","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9_-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"database":{"description":"Database to drop the extension from; omitted: the one created with the instance","type":"string","minLength":1,"maxLength":63},"cascade":{"default":false,"description":"Drop the objects that depend on the extension too; off by default, and a drop with dependents is then refused with 409 listing them","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"state":{"type":"string","const":"disabled","description":"The extension was dropped"},"cascaded":{"type":"array","items":{"type":"string"},"description":"Objects dropped with it (cascade only)"},"message":{"type":"string","description":"What happened, in a sentence"}},"required":["state","cascaded","message"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DisableDBExtension","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/extensions/{extension}/enable":{"post":{"operationId":"rds.extensions.enable","summary":"CREATE EXTENSION in a database; 202 when its library must be preloaded and the database restarted first","description":"`rds:EnableDBExtension` CREATE EXTENSION in a database; 202 when its library must be preloaded and the database restarted first.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"extension","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9_-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"database":{"description":"Database to create the extension in; omitted: the one created with the instance","type":"string","minLength":1,"maxLength":63}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"state":{"type":"string","enum":["enabled","restart-required"],"description":"enabled, or restart-required: reboot, then enable again"},"version":{"description":"Version now enabled; null when a restart is required","type":["string","null"]},"created":{"type":"array","items":{"type":"string"},"description":"Extensions installed by this call, dependencies included"},"message":{"type":"string","description":"What happened, in a sentence"}},"required":["state","version","created","message"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:EnableDBExtension","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/failover":{"post":{"operationId":"rds.instances.failover","summary":"Promote a replica and demote the current primary","description":"`rds:FailoverDBInstance` Promote a replica and demote the current primary.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"from":{"type":"string","description":"Name of the node that led before the switchover"}},"required":["from"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:FailoverDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights":{"get":{"operationId":"rds.query-insights.get","summary":"Statements of the range with load, trends and findings","description":"`rds:DescribeDBQueryInsights` Statements of the range with load, trends and findings. Statement text is normalised (no literal values). Each statement carries its sqlfp1 fingerprint, the key Error Tracking links by.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","description":"1h by the minute, 24h by 15 minutes, 7d by 2 hours","type":"string","enum":["1h","24h","7d"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"range":{"type":"string","enum":["1h","24h","7d"],"description":"The range shown"},"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Start of the range"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"End of the range"},"bucketSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Width of one point of the series, seconds"},"sampling":{"type":"object","properties":{"lastMinute":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Newest minute sampled; null: nothing sampled in the range"},"avgSampleMs":{"description":"Average time one sample took on the database, ms","type":["number","null"]},"p95SampleMs":{"description":"95th percentile of that time, ms","type":["number","null"]}},"required":["lastMinute","avgSampleMs","p95SampleMs"],"additionalProperties":false,"description":"How the history is being sampled"},"plansWithValues":{"type":"boolean","description":"Whether statements and plans are kept with their literal values"},"errorTrackingUrl":{"description":"Console page linking statements to errors; null without an Error Tracking project","type":["string","null"]},"load":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Start of the point"},"totalMs":{"type":"number","description":"Time all statements spent, ms"},"calls":{"type":"number","description":"Calls of all statements"}},"required":["at","totalMs","calls"],"additionalProperties":false},"description":"Load of the whole database over the range"},"statements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Statement id, for get-statement"},"fingerprint":{"type":"string","description":"sqlfp1 fingerprint, the key Error Tracking links by"},"query":{"type":"string","description":"Normalised statement text (no literal values)"},"database":{"type":"string","description":"Database it ran in"},"role":{"type":"string","description":"Role it ran as"},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"First time it was sampled"},"lastSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Last time it was sampled"},"calls":{"type":"number","description":"Calls in the range"},"totalMs":{"type":"number","description":"Time spent in the range, ms"},"meanMs":{"type":"number","description":"Time per call, ms"},"maxMs":{"description":"Slowest call, ms; null: unknown","type":["number","null"]},"stddevMs":{"description":"Standard deviation of a call, ms; null: unknown","type":["number","null"]},"rows":{"type":"number","description":"Rows returned or affected"},"rowsPerCall":{"type":"number","description":"Rows per call"},"cacheHitRatio":{"description":"Share of blocks served from memory, 0 to 1; null: nothing read","type":["number","null"]},"sharedBlocksRead":{"type":"number","description":"Blocks read from disk"},"sharedBlocksHit":{"type":"number","description":"Blocks served from memory"},"tempBlocksWritten":{"type":"number","description":"Temporary blocks written: sorts and hashes that spilled to disk"},"walBytes":{"type":"number","description":"WAL written, bytes"},"series":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Start of the point"},"totalMs":{"type":"number","description":"Time spent, ms"},"calls":{"type":"number","description":"Calls"}},"required":["at","totalMs","calls"],"additionalProperties":false},"description":"Its own load over the range"},"findings":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["slow-average","slow-sometimes","missing-index","spills-to-disk","n-plus-one","seq-scan-large-table","unused-index","duplicate-index","vacuum-overdue","long-running","idle-in-transaction","lock-wait"],"description":"What was found"},"severity":{"type":"string","enum":["high","medium","info"],"description":"How much it matters"},"title":{"type":"string","description":"One line: what was seen"},"evidence":{"type":"string","description":"The numbers behind it"},"action":{"type":"string","description":"What to do about it"},"sql":{"description":"A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none","type":"string"}},"required":["kind","severity","title","evidence","action"],"additionalProperties":false},"description":"Findings with suggested actions"}},"required":["id","fingerprint","query","database","role","firstSeenAt","lastSeenAt","calls","totalMs","meanMs","maxMs","stddevMs","rows","rowsPerCall","cacheHitRatio","sharedBlocksRead","sharedBlocksHit","tempBlocksWritten","walBytes","series","findings"],"additionalProperties":false},"description":"Up to 200 statements, by total time"}},"required":["range","from","to","bucketSeconds","sampling","plansWithValues","errorTrackingUrl","load","statements"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryInsights","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/sessions":{"get":{"operationId":"rds.query-insights.list-sessions","summary":"Client sessions now: what runs, how long, what it waits for, who blocks it","description":"`rds:DescribeDBQueryInsights` Client sessions now: what runs, how long, what it waits for, who blocks it.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the sessions were read"},"sessions":{"type":"array","items":{"type":"object","properties":{"pid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Server process id, for cancel-session"},"user":{"description":"Role","type":["string","null"]},"database":{"description":"Database","type":["string","null"]},"application":{"description":"application_name the client set","type":["string","null"]},"client":{"description":"Client address","type":["string","null"]},"state":{"description":"active, idle, idle in transaction, …","type":["string","null"]},"waitType":{"description":"Kind of wait, e.g. Lock","type":["string","null"]},"waitEvent":{"description":"What it waits for","type":["string","null"]},"query":{"description":"Current or last statement; normalised unless values are kept","type":["string","null"]},"querySeconds":{"description":"Seconds the statement has run","type":["number","null"]},"transactionSeconds":{"description":"Seconds the transaction has been open","type":["number","null"]},"blockedBy":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Process ids holding the locks it waits for"},"findings":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["slow-average","slow-sometimes","missing-index","spills-to-disk","n-plus-one","seq-scan-large-table","unused-index","duplicate-index","vacuum-overdue","long-running","idle-in-transaction","lock-wait"],"description":"What was found"},"severity":{"type":"string","enum":["high","medium","info"],"description":"How much it matters"},"title":{"type":"string","description":"One line: what was seen"},"evidence":{"type":"string","description":"The numbers behind it"},"action":{"type":"string","description":"What to do about it"},"sql":{"description":"A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none","type":"string"}},"required":["kind","severity","title","evidence","action"],"additionalProperties":false},"description":"Findings with suggested actions"}},"required":["pid","user","database","application","client","state","waitType","waitEvent","query","querySeconds","transactionSeconds","blockedBy","findings"],"additionalProperties":false},"description":"Client sessions, up to 200"}},"required":["at","sessions"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryInsights","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/sessions/{pid}":{"post":{"operationId":"rds.query-insights.cancel-session","summary":"Cancel a session’s running statement, or end the session","description":"`rds:CancelDBSession` Cancel a session’s running statement, or end the session.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"pid","in":"path","required":true,"schema":{"type":"integer","minimum":1,"maximum":9007199254740991}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"how":{"type":"string","enum":["cancel","terminate"],"description":"cancel: the running statement; terminate: the session"}},"required":["how"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"pid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The session"},"how":{"type":"string","enum":["cancel","terminate"],"description":"cancel: its statement was cancelled; terminate: the session was ended"}},"required":["pid","how"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CancelDBSession","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/settings":{"patch":{"operationId":"rds.query-insights.update-settings","summary":"Slow query log threshold, auto_explain, keeping values","description":"`rds:ModifyDBQueryInsights` Slow query log threshold, auto_explain, keeping values.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slowLogMs":{"description":"Log statements slower than this many ms (log_min_duration_statement); -1 is off","type":"integer","minimum":-1,"maximum":3600000},"autoExplain":{"description":"Also log the plan of slow statements (auto_explain, single-node databases)","type":"boolean"},"plansWithValues":{"description":"Show logged statements and plans with their literal values (off by default)","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"changed":{"type":"array","items":{"type":"string"},"description":"One sentence per setting that was changed"}},"required":["changed"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBQueryInsights","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/slow-log":{"get":{"operationId":"rds.query-insights.get-slow-log","summary":"Slow query log settings and the statements (and plans) it captured","description":"`rds:DescribeDBQueryInsights` Slow query log settings and the statements (and plans) it captured.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","description":"1h by the minute, 24h by 15 minutes, 7d by 2 hours","type":"string","enum":["1h","24h","7d"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"range":{"type":"string","enum":["1h","24h","7d"],"description":"The range shown"},"settings":{"anyOf":[{"type":"object","properties":{"minDurationMs":{"type":"number","description":"Statements slower than this are logged, ms; -1: off"},"autoExplain":{"type":"boolean","description":"Plans of slow statements are logged"},"explainMinMs":{"description":"Plans are logged above this, ms; null: not set","type":["number","null"]}},"required":["minDurationMs","autoExplain","explainMinMs"],"additionalProperties":false},{"type":"null"}],"description":"The settings in force; null when they could not be read"},"settingsError":{"description":"Why the settings could not be read; null when they were","type":["string","null"]},"plansWithValues":{"type":"boolean","description":"Whether statements and plans are kept with their literal values"},"topology":{"type":"string","enum":["single","cluster"],"description":"Topology of the database"},"entries":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was logged"},"node":{"type":"string","description":"Node it ran on"},"durationMs":{"type":"number","description":"How long it took, ms"},"statement":{"description":"Statement, normalised unless values are kept","type":["string","null"]},"fingerprint":{"description":"sqlfp1 fingerprint","type":["string","null"]},"planLogged":{"type":"boolean","description":"A plan was logged for this run"},"plan":{"description":"The logged plan; only when values are kept","type":["string","null"]}},"required":["at","node","durationMs","statement","fingerprint","planLogged","plan"],"additionalProperties":false},"description":"Slow statements logged in the range"}},"required":["range","settings","settingsError","plansWithValues","topology","entries"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryInsights","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/statements/{statementId}":{"get":{"operationId":"rds.query-insights.get-statement","summary":"One statement with its generic plan and the index it suggests","description":"`rds:DescribeDBQueryInsights` One statement with its generic plan and the index it suggests. EXPLAIN (GENERIC_PLAN) of the normalised text, never ANALYZE; a suggested index is a CREATE INDEX CONCURRENTLY to run yourself.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"statementId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Statement id"},"fingerprint":{"type":"string","description":"sqlfp1 fingerprint"},"query":{"type":"string","description":"Normalised statement text"},"database":{"type":"string","description":"Database it ran in"},"role":{"type":"string","description":"Role it ran as"},"plan":{"description":"Generic plan as EXPLAIN (FORMAT JSON) gives it; null when the statement cannot be planned"},"findings":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["slow-average","slow-sometimes","missing-index","spills-to-disk","n-plus-one","seq-scan-large-table","unused-index","duplicate-index","vacuum-overdue","long-running","idle-in-transaction","lock-wait"],"description":"What was found"},"severity":{"type":"string","enum":["high","medium","info"],"description":"How much it matters"},"title":{"type":"string","description":"One line: what was seen"},"evidence":{"type":"string","description":"The numbers behind it"},"action":{"type":"string","description":"What to do about it"},"sql":{"description":"A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none","type":"string"}},"required":["kind","severity","title","evidence","action"],"additionalProperties":false},"description":"Findings with suggested actions"}},"required":["id","fingerprint","query","database","role","plan","findings"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryInsights","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/insights/tables":{"get":{"operationId":"rds.query-insights.list-tables","summary":"Tables and indexes with findings: sequential scans, unused and duplicate indexes, vacuum overdue","description":"`rds:DescribeDBQueryInsights` Tables and indexes with findings: sequential scans, unused and duplicate indexes, vacuum overdue.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"database":{"type":"string","description":"Database read"},"tables":{"type":"array","items":{"type":"object","properties":{"schema":{"type":"string","description":"Schema"},"table":{"type":"string","description":"Table"},"rows":{"type":"number","description":"Live rows (estimate)"},"deadRows":{"type":"number","description":"Dead rows waiting for vacuum"},"bytes":{"type":"number","description":"Size with indexes, bytes"},"seqScans":{"type":"number","description":"Sequential scans"},"seqRowsRead":{"type":"number","description":"Rows those scans read"},"indexScans":{"description":"Index scans; null: no index","type":["number","null"]},"lastVacuum":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last vacuum; null: never"},"lastAnalyze":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Last analyze; null: never"},"findings":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["slow-average","slow-sometimes","missing-index","spills-to-disk","n-plus-one","seq-scan-large-table","unused-index","duplicate-index","vacuum-overdue","long-running","idle-in-transaction","lock-wait"],"description":"What was found"},"severity":{"type":"string","enum":["high","medium","info"],"description":"How much it matters"},"title":{"type":"string","description":"One line: what was seen"},"evidence":{"type":"string","description":"The numbers behind it"},"action":{"type":"string","description":"What to do about it"},"sql":{"description":"A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none","type":"string"}},"required":["kind","severity","title","evidence","action"],"additionalProperties":false},"description":"Findings with suggested actions"}},"required":["schema","table","rows","deadRows","bytes","seqScans","seqRowsRead","indexScans","lastVacuum","lastAnalyze","findings"],"additionalProperties":false},"description":"Up to 200 tables, largest first"},"indexFindings":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["slow-average","slow-sometimes","missing-index","spills-to-disk","n-plus-one","seq-scan-large-table","unused-index","duplicate-index","vacuum-overdue","long-running","idle-in-transaction","lock-wait"],"description":"What was found"},"severity":{"type":"string","enum":["high","medium","info"],"description":"How much it matters"},"title":{"type":"string","description":"One line: what was seen"},"evidence":{"type":"string","description":"The numbers behind it"},"action":{"type":"string","description":"What to do about it"},"sql":{"description":"A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none","type":"string"},"table":{"type":"string","description":"Table of the index"},"index":{"type":"string","description":"The index"}},"required":["kind","severity","title","evidence","action","table","index"],"additionalProperties":false},"description":"Unused and duplicate indexes"}},"required":["database","tables","indexFindings"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryInsights","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/instance-class":{"patch":{"operationId":"rds.instances.modify-instance-class","summary":"Change the machine type; a cluster is resized node by node and stays available","description":"`rds:ModifyDBInstance` Change the machine type; a cluster is resized node by node and stays available.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceClass":{"type":"string","minLength":1,"maxLength":32,"description":"The new instance type, e.g. performance-8. The provider’s own type names are still accepted, deprecated."}},"required":["instanceClass"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id"},"instanceClass":{"type":"string","description":"The instance type it is being resized to"}},"required":["id","instanceClass"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/logins":{"get":{"operationId":"rds.logins.list","summary":"List logins with who each is for, whether its role is on the server, and its open sessions","description":"`rds:DescribeDBLogins` List logins with who each is for, whether its role is on the server, and its open sessions.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"logins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Login id"},"name":{"type":"string","description":"PostgreSQL role name"},"access":{"type":"string","enum":["read","readwrite"],"description":"read: SELECT on all data; readwrite: writes too"},"secretId":{"description":"Secret holding the password; null once it is gone","type":["string","null"]},"forIamUserId":{"description":"IAM user the login is for; null: nobody in particular","type":["string","null"]},"forUsername":{"description":"That IAM user’s name","type":["string","null"]},"createdByUsername":{"description":"IAM user who created it; null once that user is deleted","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was created"},"validUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Expiry; null: none"},"expired":{"type":"boolean","description":"The expiry has passed"},"serverValidUntil":{"description":"The expiry the server enforces, when it differs from validUntil (changed by hand); absent when they agree","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"passwordRotatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the password was last rotated; null: never"},"onServer":{"description":"The role exists on the server and can log in; null: not asked","type":["boolean","null"]},"sessions":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Open sessions of the role; null: not asked"}},"required":["id","name","access","secretId","forIamUserId","forUsername","createdByUsername","createdAt","validUntil","expired","passwordRotatedAt","onServer","sessions"],"additionalProperties":false},"description":"Logins of the database, by name"},"serverError":{"description":"Why the server could not be asked; null when it was or did not need to be","type":["string","null"]}},"required":["logins","serverError"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBLogins","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rds.logins.create","summary":"Create a login (read-only by default); the password goes to Secrets, never into the response","description":"`rds:CreateDBLogin` Create a login (read-only by default); the password goes to Secrets, never into the response. Reveal the password with secrets get-value on the returned secretId (secrets:GetSecretValue, audited).","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":63,"description":"The Postgres role name: a-z, 0-9, _"},"access":{"default":"read","description":"read: SELECT on all data (pg_read_all_data); readwrite: also writes (pg_write_all_data); read when omitted","type":"string","enum":["read","readwrite"]},"forIamUserId":{"description":"IAM user the login is for, shown with it; omitted: nobody in particular","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"validUntil":{"description":"Expiry (VALID UNTIL), 5 minutes to 2 years ahead; omitted is no expiry","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Login id"},"name":{"type":"string","description":"PostgreSQL role name"},"access":{"type":"string","enum":["read","readwrite"],"description":"Access the role has"},"secretId":{"type":"string","description":"Secret holding the password (secrets get-value)"}},"required":["id","name","access","secretId"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateDBLogin","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/logins/{loginId}":{"delete":{"operationId":"rds.logins.delete","summary":"Revoke a login: end its sessions, drop its role, delete its secret","description":"`rds:DeleteDBLogin` Revoke a login: end its sessions, drop its role, delete its secret.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"loginId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Login id"},"terminated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open sessions that were ended"}},"required":["id","terminated"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteDBLogin","x-ews-mutates":true,"x-ews-sensitive":false},"patch":{"operationId":"rds.logins.modify","summary":"Set or clear a login's expiry, at least five minutes ahead (to cut off now, revoke)","description":"`rds:ModifyDBLogin` Set or clear a login's expiry, at least five minutes ahead (to cut off now, revoke). Postgres checks VALID UNTIL at connect; the expiry sweep ends sessions still open when it passes.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"loginId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"validUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"New expiry, 5 minutes to 2 years ahead; null removes the expiry"}},"required":["validUntil"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Login id"},"validUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"New expiry; null: none"}},"required":["id","validUntil"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBLogin","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/logins/{loginId}/rotate":{"post":{"operationId":"rds.logins.rotate-password","summary":"New password for a login, filed as a new version of the same secret (grants carry over)","description":"`rds:RotateDBLoginPassword` New password for a login, filed as a new version of the same secret (grants carry over).","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"loginId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endSessions":{"default":false,"description":"Also end the open sessions, which the old password opened","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Login id"},"secretId":{"type":"string","description":"Secret holding the password"},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its new version, holding the new password"},"terminated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Open sessions that were ended (0 unless endSessions was asked)"}},"required":["id","secretId","version","terminated"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:RotateDBLoginPassword","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/logs":{"get":{"operationId":"rds.instances.logs","summary":"The PostgreSQL server log from every node, newest first; filter by text, node or severity. Kept 7 days","description":"`rds:DescribeDBLogFiles` The PostgreSQL server log from every node, newest first; filter by text, node or severity. Kept 7 days.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"start","in":"query","required":false,"schema":{"description":"ISO time the lines start at; a day before end when omitted","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"end","in":"query","required":false,"schema":{"description":"ISO time the lines end at; now when omitted","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"contains","in":"query","required":false,"schema":{"description":"Only lines containing this text","type":"string","maxLength":200}},{"name":"node","in":"query","required":false,"schema":{"description":"Only this node, by its ordinal (1 for the first); omitted: every node","type":"integer","minimum":1,"maximum":99}},{"name":"severity","in":"query","required":false,"schema":{"description":"Only lines of this severity; omitted: all","type":"string","enum":["debug","info","notice","log","warning","error","fatal","panic"]}},{"name":"limit","in":"query","required":false,"schema":{"description":"At most this many lines (default 200)","type":"integer","minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"start":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Start of the range searched"},"end":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"End of the range searched"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Line id"},"ts":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was logged"},"node":{"type":"string","description":"Node it came from, e.g. node-1"},"severity":{"type":"string","description":"Severity in capitals, e.g. ERROR"},"message":{"type":"string","description":"The log line"}},"required":["id","ts","node","severity","message"],"additionalProperties":false},"description":"Lines, newest first"}},"required":["start","end","events"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBLogFiles","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/instances/{id}/maintenance":{"get":{"operationId":"rds.instances.describe-maintenance","summary":"Versions per node, the pending minor upgrade, the maintenance window and when it next opens","description":"`rds:DescribeDBInstances` Versions per node, the pending minor upgrade, the maintenance window and when it next opens.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"engineVersion":{"type":"string","description":"PostgreSQL version of the database, e.g. 17.11"},"upgradeTarget":{"description":"Minor the next maintenance window installs; null: none pending","type":["string","null"]},"upgradeableTo":{"type":"array","items":{"type":"string"},"description":"Newer minors of its major that upgrade can install"},"majorUpgradeableTo":{"type":"array","items":{"type":"string"},"description":"Newer majors it can move to, each at its pinned minor"},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minors are applied in the window"},"nextWindowStart":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the window next opens; null: no window"},"inPlaceUpgrades":{"type":"boolean","description":"Every node can be upgraded in place"},"inProgress":{"type":"boolean","description":"Maintenance is running now"},"nodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Node id"},"name":{"type":"string","description":"Node name"},"engineVersion":{"description":"Version the node runs; null until it reports","type":["string","null"]},"agent":{"type":"boolean","description":"Whether the node takes in-place maintenance work"},"lastOperation":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"],"description":"State of the operation"},"packageVersion":{"type":"string","description":"Package version it installs"},"requestedAt":{"type":"string","description":"When it was asked for"},"finishedAt":{"description":"When it finished","type":["string","null"]}},"required":["status","packageVersion","requestedAt","finishedAt"],"additionalProperties":false},{"type":"null"}],"description":"Current or last maintenance operation; null: none"}},"required":["id","name","engineVersion","agent","lastOperation"],"additionalProperties":false},"description":"Each node with a machine"}},"required":["engineVersion","upgradeTarget","upgradeableTo","majorUpgradeableTo","maintenanceWindow","autoMinorVersionUpgrade","nextWindowStart","inPlaceUpgrades","inProgress","nodes"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"rds.instances.modify-maintenance","summary":"Set the maintenance window (UTC) and automatic minor upgrades","description":"`rds:ModifyDBInstance` Set the maintenance window (UTC) and automatic minor upgrades.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maintenanceWindow":{"description":"UTC, ddd:hh24:mi-ddd:hh24:mi, one hour to one day, e.g. sun:05:00-sun:06:00 (the default); omitted: unchanged","type":"string","maxLength":32,"pattern":"^(sun|mon|tue|wed|thu|fri|sat):([01]\\d|2[0-3]):[0-5]\\d-(sun|mon|tue|wed|thu|fri|sat):([01]\\d|2[0-3]):[0-5]\\d$"},"autoMinorVersionUpgrade":{"description":"Apply new minor versions in the window automatically (on by default); omitted: unchanged","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minors are applied in the window"}},"required":["maintenanceWindow","autoMinorVersionUpgrade"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/master-password/rotate":{"post":{"operationId":"rds.instances.rotate-master-password","summary":"Rotate the master password and file the new version in Secrets","description":"`rds:ModifyDBInstance` Rotate the master password and file the new version in Secrets.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"secretId":{"type":"string","description":"Secret holding the master password"},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its new version, holding the new password"}},"required":["secretId","version"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/nodes":{"get":{"operationId":"rds.instances.list-nodes","summary":"List the machines backing a database instance","description":"`rds:DescribeDBInstances` List the machines backing a database instance.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Node id"},"dbInstanceId":{"type":"string","description":"Database the node belongs to"},"orgId":{"type":"string","description":"Organization that owns the database"},"ordinal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"1-based position; 1 to 3 are the core members, higher ones readers"},"name":{"type":"string","description":"Machine name"},"role":{"type":"string","enum":["primary","replica"],"description":"Role as last observed: primary leads"},"status":{"type":"string","enum":["provisioning","bootstrapping","running","stopped","failed","deleting"],"description":"State of the machine"},"hetznerServerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the machine; null before it is bought"},"hetznerVolumeId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the data volume; null before it is created"},"availabilityZoneId":{"description":"Zone of the machine and its volume; null: the region's default zone","type":["string","null"]},"diskUsedPercent":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Data volume usage as last reported, percent; null: not reported"},"privateIpv4":{"description":"Address on the cluster's private network","type":["string","null"]},"publicIpv4":{"description":"Public address of the machine","type":["string","null"]},"vpcIpv4":{"description":"Address in the database's VPC; null: none","type":["string","null"]},"lastSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the node last reported"},"engineVersion":{"description":"PostgreSQL version the server reports, e.g. 17.11; null until it answers","type":["string","null"]},"engineVersionReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When engineVersion was read"},"maintenanceAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the node last asked for maintenance work; null: it cannot be upgraded in place"},"installedPackageVersion":{"description":"PostgreSQL package installed on the node","type":["string","null"]},"maintenanceOperation":{"description":"The current or last in-place maintenance operation of the node; null: none"},"poolerRebootSafeAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the connection pooler was last confirmed to come back after a reboot"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the node was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the node record last changed"}},"required":["id","dbInstanceId","orgId","ordinal","name","role","status","hetznerServerId","hetznerVolumeId","availabilityZoneId","diskUsedPercent","privateIpv4","publicIpv4","vpcIpv4","lastSeenAt","engineVersion","engineVersionReportedAt","maintenanceAgentSeenAt","installedPackageVersion","maintenanceOperation","poolerRebootSafeAt","createdAt","updatedAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/parameters":{"get":{"operationId":"rds.instances.describe-parameters","summary":"Every settable PostgreSQL parameter: its machine-sized default, your value, what runs now","description":"`rds:DescribeDBParameters` Every settable PostgreSQL parameter: its machine-sized default, your value, what runs now.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"memoryGib":{"description":"Memory of the instance type the defaults are sized from, GiB; null: unknown type","type":["number","null"]},"runningError":{"description":"Why the running values could not be read; null when they were","type":["string","null"]},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name, e.g. work_mem"},"category":{"type":"string","enum":["Memory","Connections","Query tuning","Timeouts","Logging","Autovacuum","WAL"],"description":"Group it is shown in"},"description":{"type":"string","description":"What it does"},"kind":{"type":"string","enum":["memory","duration","integer","real","bool","enum"],"description":"Kind of value it takes"},"restart":{"type":"boolean","description":"A change takes effect at the next restart"},"default":{"description":"Default sized from the machine; null: unknown type","type":["string","null"]},"value":{"description":"Your value; null: the default","type":["string","null"]},"running":{"description":"Value the server runs now; null when it could not be read","type":["string","null"]},"pendingRestart":{"type":"boolean","description":"The server waits for a restart to apply a change"}},"required":["name","category","description","kind","restart","default","value","running","pendingRestart"],"additionalProperties":false},"description":"Every settable parameter"}},"required":["memoryGib","runningError","parameters"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBParameters","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"rds.instances.modify-parameters","summary":"Set or reset PostgreSQL parameters; most apply at once, the answer lists those that wait for a restart","description":"`rds:ModifyDBParameters` Set or reset PostgreSQL parameters; most apply at once, the answer lists those that wait for a restart.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parameters":{"type":"object","propertyNames":{"type":"string","maxLength":64},"additionalProperties":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"description":"Parameter name → value (\"32MB\", \"30s\", \"on\"), or null to return it to its machine-sized default; parameters not named keep their value"}},"required":["parameters"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"pendingRestart":{"type":"array","items":{"type":"string"},"description":"Parameters that take effect at the next restart"},"notApplied":{"type":"array","items":{"type":"string"},"description":"Parameters not in effect because the machines set them locally"}},"required":["pendingRestart","notApplied"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBParameters","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/query-stats":{"get":{"operationId":"rds.data.query-stats","summary":"Top statements by time, calls or rows from pg_stat_statements; installed: false until the extension is on","description":"`rds:DescribeDBQueryStats` Top statements by time, calls or rows from pg_stat_statements; installed: false until the extension is on.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"order","in":"query","required":false,"schema":{"default":"total_time","description":"What the statements are ranked by; total_time when omitted","type":"string","enum":["total_time","mean_time","calls","rows"]}},{"name":"limit","in":"query","required":false,"schema":{"default":25,"description":"At most this many statements; 25 when omitted","type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"installed":{"type":"boolean","const":false,"description":"pg_stat_statements is installed in the database (false here)"}},"required":["installed"],"additionalProperties":false},{"type":"object","properties":{"installed":{"type":"boolean","const":true,"description":"pg_stat_statements is installed in the database"},"since":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the statistics were last reset; null: unknown"},"statements":{"type":"array","items":{"type":"object","properties":{"queryId":{"description":"PostgreSQL query id","type":["string","null"]},"query":{"type":"string","description":"Normalised statement text, cut at 2,000 characters"},"calls":{"type":"number","description":"Calls"},"totalMs":{"type":"number","description":"Time spent, ms"},"meanMs":{"type":"number","description":"Time per call, ms"},"rows":{"type":"number","description":"Rows returned or affected"},"cacheHitRatio":{"description":"Share of blocks served from memory, 0 to 1; null: nothing read","type":["number","null"]},"user":{"description":"Role it ran as","type":["string","null"]}},"required":["queryId","query","calls","totalMs","meanMs","rows","cacheHitRatio","user"],"additionalProperties":false},"description":"The top statements in the order asked for"}},"required":["installed","since","statements"],"additionalProperties":false}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBQueryStats","x-ews-mutates":false,"x-ews-sensitive":true}},"/rds/api/instances/{id}/readers":{"post":{"operationId":"rds.instances.add-reader","summary":"Add a read replica to a cluster; it serves on the reader endpoint (5433, 6433) once streaming","description":"`rds:CreateDBReadReplica` Add a read replica to a cluster; it serves on the reader endpoint (5433, 6433) once streaming.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Node id"},"dbInstanceId":{"type":"string","description":"Database the node belongs to"},"orgId":{"type":"string","description":"Organization that owns the database"},"ordinal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"1-based position; 1 to 3 are the core members, higher ones readers"},"name":{"type":"string","description":"Machine name"},"role":{"type":"string","enum":["primary","replica"],"description":"Role as last observed: primary leads"},"status":{"type":"string","enum":["provisioning","bootstrapping","running","stopped","failed","deleting"],"description":"State of the machine"},"hetznerServerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the machine; null before it is bought"},"hetznerVolumeId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the data volume; null before it is created"},"availabilityZoneId":{"description":"Zone of the machine and its volume; null: the region's default zone","type":["string","null"]},"diskUsedPercent":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Data volume usage as last reported, percent; null: not reported"},"privateIpv4":{"description":"Address on the cluster's private network","type":["string","null"]},"publicIpv4":{"description":"Public address of the machine","type":["string","null"]},"vpcIpv4":{"description":"Address in the database's VPC; null: none","type":["string","null"]},"lastSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the node last reported"},"engineVersion":{"description":"PostgreSQL version the server reports, e.g. 17.11; null until it answers","type":["string","null"]},"engineVersionReportedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When engineVersion was read"},"maintenanceAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the node last asked for maintenance work; null: it cannot be upgraded in place"},"installedPackageVersion":{"description":"PostgreSQL package installed on the node","type":["string","null"]},"maintenanceOperation":{"description":"The current or last in-place maintenance operation of the node; null: none"},"poolerRebootSafeAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the connection pooler was last confirmed to come back after a reboot"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the node was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the node record last changed"}},"required":["id","dbInstanceId","orgId","ordinal","name","role","status","hetznerServerId","hetznerVolumeId","availabilityZoneId","diskUsedPercent","privateIpv4","publicIpv4","vpcIpv4","lastSeenAt","engineVersion","engineVersionReportedAt","maintenanceAgentSeenAt","installedPackageVersion","maintenanceOperation","poolerRebootSafeAt","createdAt","updatedAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateDBReadReplica","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/readers/{nodeId}":{"delete":{"operationId":"rds.instances.remove-reader","summary":"Remove a read replica, its machine and its volume","description":"`rds:DeleteDBReadReplica` Remove a read replica, its machine and its volume.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"nodeId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Node id"},"status":{"type":"string","const":"deleting","description":"The reader is being removed"}},"required":["id","status"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteDBReadReplica","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/replication":{"get":{"operationId":"rds.replication.get","summary":"The replication mode and whether it holds right now: ok, degraded (no standby acknowledging), async","description":"`rds:DescribeDBInstances` The replication mode and whether it holds right now: ok, degraded (no standby acknowledging), async.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"mode":{"type":"string","enum":["async","sync"],"description":"The mode asked for"},"state":{"type":"string","enum":["ok","degraded","async","unknown"],"description":"ok: sync and a standby acknowledges commits; degraded: sync but none does; async; unknown: the cluster did not answer"},"syncStandbys":{"type":"array","items":{"type":"string"},"description":"Members a commit waits for (any one of them)"}},"required":["mode","state","syncStandbys"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"rds.replication.set","summary":"Make a cluster synchronous or asynchronous (live, no restart), and/or turn logical replication on or off (with a restart)","description":"`rds:ModifyDBInstance` Make a cluster synchronous or asynchronous (live, no restart), and/or turn logical replication on or off (with a restart). Synchronous is not strict: with no standby streaming, the leader keeps accepting writes and the health check reports sync-degraded until one is back. logicalReplication sets wal_level = logical; a cluster restarts member by member with one switchover, a single node restarts once (writes pause for the restart). Turning it off is refused while any logical slot exists.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"replicationMode":{"description":"Cluster only, applied live. sync: a commit waits for one standby, so a failover loses nothing acknowledged; async: it does not wait. Omitted: unchanged","type":"string","enum":["async","sync"]},"logicalReplication":{"description":"wal_level = logical for CDC and publications, applied with a restart; omitted: unchanged","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"instance":{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption"],"additionalProperties":false,"description":"The database"},"applied":{"type":"boolean","description":"The cluster took the replication mode (always true when it was not sent)"},"replication":{"anyOf":[{"type":"object","properties":{"mode":{"type":"string","enum":["async","sync"],"description":"The mode asked for"},"state":{"type":"string","enum":["ok","degraded","async","unknown"],"description":"ok: sync and a standby acknowledges commits; degraded: sync but none does; async; unknown: the cluster did not answer"},"syncStandbys":{"type":"array","items":{"type":"string"},"description":"Members a commit waits for (any one of them)"}},"required":["mode","state","syncStandbys"],"additionalProperties":false},{"type":"null"}],"description":"Replication now; null when replicationMode was not sent"},"logicalReplication":{"type":"object","properties":{"enabled":{"type":"boolean","description":"wal_level logical is asked for"},"applying":{"type":"boolean","description":"A restart that applies it was started by this call"}},"required":["enabled","applying"],"additionalProperties":false,"description":"Logical replication"}},"required":["instance","applied","replication","logicalReplication"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/replication-slots":{"get":{"operationId":"rds.replication-slots.list","summary":"Every logical slot on the leader (declared or made in SQL): active, lag, WAL retained, whether it survives a failover","description":"`rds:DescribeDBInstances` Every logical slot on the leader (declared or made in SQL): active, lag, WAL retained, whether it survives a failover.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical"},"slots":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Slot name"},"database":{"description":"Database the slot decodes","type":["string","null"]},"plugin":{"description":"Output plugin, e.g. pgoutput","type":["string","null"]},"managed":{"type":"boolean","description":"Declared through the API (kept on every member), or made in SQL"},"active":{"type":"boolean","description":"A consumer is reading it now"},"activePid":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Server process of that consumer"},"temporary":{"type":"boolean","description":"Dropped when its session ends"},"walStatus":{"description":"reserved, extended, unreserved or lost (the WAL it needs is gone)","type":["string","null"]},"confirmedFlushLsn":{"description":"Position the consumer has confirmed","type":["string","null"]},"restartLsn":{"description":"Oldest WAL position the slot still needs","type":["string","null"]},"retainedBytes":{"description":"WAL the slot holds on the leader, bytes","type":["number","null"]},"survivesFailover":{"description":"Whether it is kept when another member takes over; null on a single node","type":["boolean","null"]}},"required":["name","database","plugin","managed","active","activePid","temporary","walStatus","confirmedFlushLsn","restartLsn","retainedBytes","survivesFailover"],"additionalProperties":false},"description":"Every logical slot on the leader"},"pending":{"type":"array","items":{"type":"string"},"description":"Declared slots the leader has not created yet"},"error":{"description":"Why the slots could not be read; null when they were","type":["string","null"]}},"required":["logicalReplication","slots","pending","error"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"rds.replication-slots.create","summary":"Declare a logical slot (pgoutput); on a cluster it is kept on every member","description":"`rds:CreateDBReplicationSlot` Declare a logical slot (pgoutput); on a cluster it is kept on every member. Needs logicalReplication on. Connect the consumer to port 5432 (direct, not the pooler) with a role that has REPLICATION, e.g. the master user. An inactive slot holds WAL until max_slot_wal_keep_size invalidates it; the health check warns from 1 GiB.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Slot name: a-z, 0-9, _; starts with a letter"},"database":{"type":"string","minLength":1,"maxLength":63,"description":"The database the slot decodes"},"plugin":{"default":"pgoutput","description":"Output plugin","type":"string","enum":["pgoutput"]}},"required":["name","database"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"slot":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","description":"Slot name"},"database":{"description":"Database the slot decodes","type":["string","null"]},"plugin":{"description":"Output plugin, e.g. pgoutput","type":["string","null"]},"managed":{"type":"boolean","description":"Declared through the API (kept on every member), or made in SQL"},"active":{"type":"boolean","description":"A consumer is reading it now"},"activePid":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Server process of that consumer"},"temporary":{"type":"boolean","description":"Dropped when its session ends"},"walStatus":{"description":"reserved, extended, unreserved or lost (the WAL it needs is gone)","type":["string","null"]},"confirmedFlushLsn":{"description":"Position the consumer has confirmed","type":["string","null"]},"restartLsn":{"description":"Oldest WAL position the slot still needs","type":["string","null"]},"retainedBytes":{"description":"WAL the slot holds on the leader, bytes","type":["number","null"]},"survivesFailover":{"description":"Whether it is kept when another member takes over; null on a single node","type":["boolean","null"]}},"required":["name","database","plugin","managed","active","activePid","temporary","walStatus","confirmedFlushLsn","restartLsn","retainedBytes","survivesFailover"],"additionalProperties":false},{"type":"null"}],"description":"The slot as the leader shows it; null: not created yet"},"declared":{"type":"object","properties":{"name":{"type":"string","description":"Slot name"},"database":{"type":"string","description":"Database it decodes"},"plugin":{"type":"string","const":"pgoutput","description":"Output plugin"}},"required":["name","database","plugin"],"additionalProperties":false,"description":"The declaration kept by the platform"}},"required":["slot","declared"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:CreateDBReplicationSlot","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/replication-slots/{slot}":{"delete":{"operationId":"rds.replication-slots.delete","summary":"Drop a logical slot, declared or made in SQL; its consumer has to resynchronise","description":"`rds:DeleteDBReplicationSlot` Drop a logical slot, declared or made in SQL; its consumer has to resynchronise. An active slot is refused (409) unless force=true, which ends the connection reading it.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"slot","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z0-9_]{1,63}$"}},{"name":"force","in":"query","required":false,"schema":{"default":"false","description":"true: end the connection reading an active slot first","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string","description":"The slot"},"deleted":{"type":"boolean","const":true,"description":"It was dropped"}},"required":["name","deleted"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DeleteDBReplicationSlot","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/restore":{"post":{"operationId":"rds.backups.restore","summary":"Restore to latest, to a timestamp, or to a labelled backup","description":"`rds:RestoreDBInstance` Restore to latest, to a timestamp, or to a labelled backup.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":1,"maxLength":63,"description":"Name of the new database the restore creates; a restore never overwrites its source"},"instanceClass":{"description":"Instance type of the new database, e.g. performance-2 (provider names deprecated); omitted: the source's","type":"string","minLength":1},"topology":{"description":"single (the default) or cluster: three nodes, the class needs 8 GiB of memory or more","type":"string","enum":["single","cluster"]},"kmsKeyId":{"description":"KMS key for the new database's disks; null: the platform key; omitted: the source's","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"publiclyAccessible":{"description":"Whether the new database answers on the internet; omitted: the source's choice","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"latest"}},"required":["targetIdentifier","recoveryTarget"]},{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":1,"maxLength":63,"description":"Name of the new database the restore creates; a restore never overwrites its source"},"instanceClass":{"description":"Instance type of the new database, e.g. performance-2 (provider names deprecated); omitted: the source's","type":"string","minLength":1},"topology":{"description":"single (the default) or cluster: three nodes, the class needs 8 GiB of memory or more","type":"string","enum":["single","cluster"]},"kmsKeyId":{"description":"KMS key for the new database's disks; null: the platform key; omitted: the source's","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"publiclyAccessible":{"description":"Whether the new database answers on the internet; omitted: the source's choice","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"time"},"recoveryTargetTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO time to restore to; must lie inside the recoverable window of backups list"}},"required":["targetIdentifier","recoveryTarget","recoveryTargetTime"]},{"type":"object","properties":{"targetIdentifier":{"type":"string","minLength":1,"maxLength":63,"description":"Name of the new database the restore creates; a restore never overwrites its source"},"instanceClass":{"description":"Instance type of the new database, e.g. performance-2 (provider names deprecated); omitted: the source's","type":"string","minLength":1},"topology":{"description":"single (the default) or cluster: three nodes, the class needs 8 GiB of memory or more","type":"string","enum":["single","cluster"]},"kmsKeyId":{"description":"KMS key for the new database's disks; null: the platform key; omitted: the source's","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"publiclyAccessible":{"description":"Whether the new database answers on the internet; omitted: the source's choice","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"recoveryTarget":{"type":"string","const":"label"},"recoveryTargetLabel":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$","description":"Label of the backup to restore, as backups list shows it (e.g. 20260826-030000F)"}},"required":["targetIdentifier","recoveryTarget","recoveryTargetLabel"]}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string","description":"Restore job id"},"orgId":{"type":"string","description":"Organization that owns the databases"},"sourceDbInstanceId":{"type":"string","description":"Database whose backups are restored"},"targetDbInstanceId":{"description":"New database the restore builds; null once that database is deleted","type":["string","null"]},"recoveryTarget":{"type":"string","enum":["latest","time","label"],"description":"latest, a point in time, or a labelled backup"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The point in time, for time"},"recoveryTargetLabel":{"description":"The backup label, for label","type":["string","null"]},"baseBackupLabel":{"description":"Backup the restore starts from; set when it starts","type":["string","null"]},"status":{"type":"string","enum":["queued","restoring","completed","cancelled","failed"],"description":"cancelled: withdrawn before it started"},"error":{"description":"Why it failed or who cancelled it; null otherwise","type":["string","null"]},"requestedByIamUserId":{"description":"IAM user who asked; null once that user is deleted","type":["string","null"]},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the restore started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished or was cancelled"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was requested"}},"required":["id","orgId","sourceDbInstanceId","targetDbInstanceId","recoveryTarget","recoveryTargetTime","recoveryTargetLabel","baseBackupLabel","status","error","requestedByIamUserId","startedAt","finishedAt","createdAt"],"additionalProperties":false,"description":"The restore job"},"target":{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption"],"additionalProperties":false,"description":"The new database the restore builds"}},"required":["job","target"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:RestoreDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/restore-jobs":{"get":{"operationId":"rds.backups.list-restore-jobs","summary":"List restore jobs for a database instance","description":"`rds:ListBackups` List restore jobs for a database instance.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Restore job id"},"orgId":{"type":"string","description":"Organization that owns the databases"},"sourceDbInstanceId":{"type":"string","description":"Database whose backups are restored"},"targetDbInstanceId":{"description":"New database the restore builds; null once that database is deleted","type":["string","null"]},"recoveryTarget":{"type":"string","enum":["latest","time","label"],"description":"latest, a point in time, or a labelled backup"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The point in time, for time"},"recoveryTargetLabel":{"description":"The backup label, for label","type":["string","null"]},"baseBackupLabel":{"description":"Backup the restore starts from; set when it starts","type":["string","null"]},"status":{"type":"string","enum":["queued","restoring","completed","cancelled","failed"],"description":"cancelled: withdrawn before it started"},"error":{"description":"Why it failed or who cancelled it; null otherwise","type":["string","null"]},"requestedByIamUserId":{"description":"IAM user who asked; null once that user is deleted","type":["string","null"]},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the restore started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished or was cancelled"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was requested"}},"required":["id","orgId","sourceDbInstanceId","targetDbInstanceId","recoveryTarget","recoveryTargetTime","recoveryTargetLabel","baseBackupLabel","status","error","requestedByIamUserId","startedAt","finishedAt","createdAt"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ListBackups","x-ews-mutates":false,"x-ews-sensitive":false}},"/rds/api/instances/{id}/rotate-storage-key":{"post":{"operationId":"rds.instances.rotate-storage-key","summary":"Replace the LUKS passphrase of every node’s data volume with a new key","description":"`rds:RotateDBStorageKey` Replace the LUKS passphrase of every node’s data volume with a new key. Answers 202 with each volume’s key version. Each node adds the new key, removes the old one and reports within five minutes; nothing restarts. Nodes built before key rotation existed do not poll for it: replace them or restore into a new database. The dm-crypt volume key itself is not changed.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"volumes":{"type":"array","items":{"type":"object","properties":{"providerVolumeId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the volume; null for a disk on the platform's own hosts"},"diskId":{"description":"Id of a disk on the platform's own hosts; null otherwise","type":["string","null"]},"keyVersion":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Version of the volume key"},"rotationPending":{"type":"boolean","description":"The node has not finished the rotation yet"},"rotatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the key was last rotated; null: never"}},"required":["providerVolumeId","diskId","keyVersion","rotationPending","rotatedAt"],"additionalProperties":false},"description":"Every data volume of the database"}},"required":["volumes"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:RotateDBStorageKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/storage":{"patch":{"operationId":"rds.instances.modify-storage","summary":"Resize storage or change the autoscaling ceiling","description":"`rds:ModifyDBInstance` Resize storage or change the autoscaling ceiling.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allocatedStorageGib":{"description":"New size of every node's data volume in GiB; storage only grows. Omitted: unchanged","type":"integer","minimum":10,"maximum":10000},"maxAllocatedStorageGib":{"description":"Autoscaling ceiling in GiB, not below the storage size; null turns automatic growth off; omitted: unchanged","anyOf":[{"type":"integer","minimum":10,"maximum":10000},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Database id (ewdb-…)"},"orgId":{"type":"string","description":"Organization that owns the database"},"identifier":{"type":"string","description":"Name of the database, unique within the organization"},"engine":{"type":"string","enum":["postgres","docdb"],"description":"Database engine; postgres for every managed PostgreSQL database"},"engineVersion":{"type":"string","description":"PostgreSQL version the database is on, a pinned minor such as 17.11"},"instanceClass":{"type":"string","description":"Instance type of every node, e.g. performance-2"},"regionId":{"type":"string","description":"Region the database is in, e.g. de1"},"availabilityZoneId":{"description":"Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a cluster","type":["string","null"]},"vpcId":{"description":"VPC the database joins; null: none","type":["string","null"]},"subnetId":{"description":"Subnet of that VPC its addresses come from; null: the VPC's whole range","type":["string","null"]},"dbName":{"description":"Database created inside the server at launch","type":["string","null"]},"masterUsername":{"type":"string","description":"Name of the master role, whose password is filed in Secrets"},"allocatedStorageGib":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Size of each node's data volume, GiB"},"maxAllocatedStorageGib":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Autoscaling ceiling, GiB; null: automatic growth is off"},"storageType":{"type":"string","description":"Storage class label; informational"},"iops":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Provisioned IOPS; not offered, so null"},"multiAz":{"type":"boolean","description":"Not used: zonePlacement says how a cluster is spread over zones"},"publiclyAccessible":{"type":"boolean","description":"Whether the database answers on the internet; false: only from its VPC"},"topology":{"type":"string","enum":["single","cluster"],"description":"single: one node; cluster: three nodes with automatic failover"},"nodeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Core nodes: 1 for single, 3 for a cluster (readers not counted)"},"masterSecretId":{"description":"Secret holding the master password; null until it is filed","type":["string","null"]},"loadBalancerId":{"description":"Load balancer in front of a cluster, on the platform's own fleet; null otherwise","type":["string","null"]},"endpointKind":{"anyOf":[{"type":"string","enum":["hetzner-lb","fleet"]},{"type":"null"}],"description":"What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single node"},"hetznerLoadBalancerId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of a cluster's load balancer; null when there is none"},"hetznerNetworkId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the private network a cluster's members talk over; null on a single node"},"hetznerFirewallId":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The provider's id of the database's firewall; null before it exists"},"reconcileError":{"description":"Why the last provisioning or teardown step failed; null when nothing failed","type":["string","null"]},"capacityFallback":{"type":"object","properties":{"otherZones":{"type":"boolean","description":"A sold-out zone may be replaced by another zone of the region"},"equivalentTypes":{"type":"boolean","description":"A sold-out instance type may be replaced by an equivalent one"}},"required":["otherZones","equivalentTypes"],"additionalProperties":false,"description":"What the create could fall back to when its type was sold out"},"onStockOut":{"type":"string","enum":["fail","wait"],"description":"Sold out with no fallback: fail the create, or wait for stock"},"capacityWaitUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"While waiting for stock: when the create gives up; null otherwise"},"requestedInstanceClass":{"description":"The instance type asked for, when a stock fallback bought another; null otherwise","type":["string","null"]},"status":{"type":"string","enum":["available","creating","modifying","backing-up","deleting","failed","stopped","starting","stopping","rebooting","maintenance","waiting-for-capacity","retained"],"description":"State of the database"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"For a retained database: when its backups are removed; null otherwise"},"endpointAddress":{"description":"Address clients connect to; null until the database is reachable","type":["string","null"]},"endpointPort":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432"},"privateEndpointAddress":{"description":"The database's address inside its VPC, named in its certificate; null: use endpointAddress","type":["string","null"]},"parameterGroupId":{"description":"Not used; parameters holds your values","type":["string","null"]},"backupRetentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Days backups are kept; 0: scheduled backups are off"},"backupsEnabled":{"type":"boolean","description":"Whether scheduled backups are taken"},"storageEncrypted":{"type":"boolean","description":"Whether every node's data volume is encrypted at rest"},"storageKmsKeyId":{"description":"KMS key that wraps every node volume's key; null: the platform key","type":["string","null"]},"backupAgentSeenAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a node last asked for backup work; null: never"},"backupPollerVersion":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reported"},"lastBackupAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the newest backup finished; null: never"},"backupWindow":{"description":"When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)","type":["string","null"]},"maintenanceWindow":{"description":"Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi","type":["string","null"]},"deletionProtection":{"type":"boolean","description":"While true, delete is refused"},"performanceInsightsEnabled":{"type":"boolean","description":"Not used; query insights are always on"},"autoMinorVersionUpgrade":{"type":"boolean","description":"Whether new minor versions are applied in the maintenance window"},"parameters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Your PostgreSQL parameter values by name; parameters not named keep their default"},"caCertIdentifier":{"description":"Name of the CA that signs the server certificate","type":["string","null"]},"tlsSerial":{"description":"Serial of the server certificate; null: the database has no certificate","type":["string","null"]},"tlsNotAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the server certificate expires"},"tlsNamesInCert":{"type":"boolean","description":"Whether the certificate names the database's DNS endpoint names"},"tlsRequired":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"replicationMode":{"anyOf":[{"type":"string","enum":["async","sync"]},{"type":"null"}],"description":"sync: a commit waits for one standby; async: it does not; null on a single node"},"zonePlacement":{"anyOf":[{"type":"string","enum":["spread","single"]},{"type":"null"}],"description":"spread: members over the zones; single: all in one zone; null on a single node"},"logicalReplication":{"type":"boolean","description":"Whether wal_level is logical, for CDC and publications"},"branchPoolOf":{"description":"Set on the machine that serves the branches of another database: that database; null otherwise","type":["string","null"]},"branchSettings":{"description":"Branch settings as stored (branch-settings reads them); null: the defaults"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the database first became available"},"tags":{"description":"Kept for compatibility; the tags API holds the tags of the database","type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When the database record last changed"},"encryption":{"type":"object","properties":{"storage":{"type":"string","enum":["luks2","none"],"description":"luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryption"},"backups":{"type":"string","enum":["aes-256-cbc","none"],"description":"aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryption"}},"required":["storage","backups"],"additionalProperties":false,"description":"What is encrypted at rest"}},"required":["id","orgId","identifier","engine","engineVersion","instanceClass","regionId","availabilityZoneId","vpcId","subnetId","dbName","masterUsername","allocatedStorageGib","maxAllocatedStorageGib","storageType","iops","multiAz","publiclyAccessible","topology","nodeCount","masterSecretId","loadBalancerId","endpointKind","hetznerLoadBalancerId","hetznerNetworkId","hetznerFirewallId","reconcileError","capacityFallback","onStockOut","capacityWaitUntil","requestedInstanceClass","status","retainedUntil","endpointAddress","endpointPort","privateEndpointAddress","parameterGroupId","backupRetentionDays","backupsEnabled","storageEncrypted","storageKmsKeyId","backupAgentSeenAt","backupPollerVersion","lastBackupAt","backupWindow","maintenanceWindow","deletionProtection","performanceInsightsEnabled","autoMinorVersionUpgrade","parameters","caCertIdentifier","tlsSerial","tlsNotAfter","tlsNamesInCert","tlsRequired","replicationMode","zonePlacement","logicalReplication","branchPoolOf","branchSettings","launchedAt","tags","createdAt","updatedAt","encryption"],"additionalProperties":false},{"type":"null"}]}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/tls":{"get":{"operationId":"rds.tls.get","summary":"The TLS requirement and certificate; with clients=true, every client connected without TLS on either port","description":"`rds:DescribeDBInstances` The TLS requirement and certificate; with clients=true, every client connected without TLS on either port.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}},{"name":"clients","in":"query","required":false,"schema":{"default":"false","description":"Also list the clients connected without TLS right now","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether clients that do not use TLS are refused"},"certificate":{"anyOf":[{"type":"object","properties":{"serial":{"type":"string","description":"Serial of the server certificate"},"notAfter":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it expires"}},"required":["serial","notAfter"],"additionalProperties":false},{"type":"null"}],"description":"The server certificate; null: the database has none"},"plaintextClients":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"node":{"type":"string","description":"Node the client is connected to"},"port":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"5432 (direct) or 6432 (pooler)"},"user":{"type":"string","description":"Role"},"database":{"description":"Database","type":["string","null"]},"application":{"description":"application_name the client set","type":["string","null"]},"address":{"type":"string","description":"Client address"},"connections":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Connections from it"}},"required":["node","port","user","database","application","address","connections"],"additionalProperties":false}},{"type":"null"}],"description":"Clients connected without TLS now; null unless clients=true was asked"},"unaskedNodes":{"type":"array","items":{"type":"string"},"description":"Nodes that could not be asked for their clients"},"plaintextError":{"description":"Why the clients could not be listed; null otherwise","type":["string","null"]}},"required":["required","certificate","plaintextClients","unaskedNodes","plaintextError"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"rds.tls.set","summary":"Require TLS (hostssl, PgBouncer require) or stop requiring it, on every node; verified by a plaintext probe","description":"`rds:ModifyDBInstance` Require TLS (hostssl, PgBouncer require) or stop requiring it, on every node; verified by a plaintext probe. Open sessions are not cut: pg_hba and the pooler are consulted when a connection starts, so a plaintext client breaks at its next reconnect.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"true: refuse plaintext clients on ports 5432 and 6432; false: accept them again. Open sessions are not cut"}},"required":["required"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"required":{"type":"boolean","description":"The setting now stored"},"verified":{"type":"boolean","description":"Every node applied it and a plaintext probe confirmed it on both ports"},"changed":{"type":"boolean","description":"A configuration was rewritten by this call"},"cluster":{"anyOf":[{"type":"string","enum":["already","updated","unreachable","failed"]},{"type":"null"}],"description":"The cluster's shared client rules: already, updated, unreachable or failed; null on a single node"},"nodes":{"type":"array","items":{"type":"object","properties":{"node":{"type":"string","description":"Node name"},"outcome":{"type":"string","enum":["already","updated","unreachable","failed"],"description":"already (nothing to change), updated, unreachable (retried later) or failed"}},"required":["node","outcome"],"additionalProperties":false},"description":"Outcome per node"},"probes":{"type":"array","items":{"type":"object","properties":{"node":{"type":"string","description":"Node name"},"direct":{"type":"string","enum":["refused","accepted","unreachable"],"description":"A plaintext connection to 5432: refused, accepted or unreachable"},"pooled":{"type":"string","enum":["refused","accepted","unreachable"],"description":"A plaintext connection to 6432: refused, accepted or unreachable"}},"required":["node","direct","pooled"],"additionalProperties":false},"description":"Plaintext probe of each running node"}},"required":["required","verified","changed","cluster","nodes","probes"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/instances/{id}/upgrade":{"post":{"operationId":"rds.instances.upgrade","summary":"Upgrade to a newer minor now: a cluster rolls node by node with one switchover, a single node restarts once","description":"`rds:ModifyDBInstance` Upgrade to a newer minor now: a cluster rolls node by node with one switchover, a single node restarts once.","tags":["Postgres"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"^(?!ewdoc-)[a-z0-9-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"engineVersion":{"description":"A pinned minor (e.g. 17.11) or a major (e.g. 18, meaning its pinned minor): the database's own major, or a newer one for a major upgrade; omitted: the newest pinned minor of its major","type":"string","minLength":1,"maxLength":16}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Database id"},"engineVersion":{"type":"string","description":"The version being installed, e.g. 17.11"}},"required":["id","engineVersion"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:ModifyDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/restore-jobs/{jobId}":{"delete":{"operationId":"rds.backups.cancel-restore","summary":"Withdraw a restore request that has not started","description":"`rds:RestoreDBInstance` Withdraw a restore request that has not started. Refused with 409 once the restore is past `queued`: delete the database it is building instead. Cancelling also removes the placeholder target database, provided nothing has been provisioned for it yet.","tags":["Postgres"],"parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Restore job id"},"orgId":{"type":"string","description":"Organization that owns the databases"},"sourceDbInstanceId":{"type":"string","description":"Database whose backups are restored"},"targetDbInstanceId":{"description":"New database the restore builds; null once that database is deleted","type":["string","null"]},"recoveryTarget":{"type":"string","enum":["latest","time","label"],"description":"latest, a point in time, or a labelled backup"},"recoveryTargetTime":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"The point in time, for time"},"recoveryTargetLabel":{"description":"The backup label, for label","type":["string","null"]},"baseBackupLabel":{"description":"Backup the restore starts from; set when it starts","type":["string","null"]},"status":{"type":"string","enum":["queued","restoring","completed","cancelled","failed"],"description":"cancelled: withdrawn before it started"},"error":{"description":"Why it failed or who cancelled it; null otherwise","type":["string","null"]},"requestedByIamUserId":{"description":"IAM user who asked; null once that user is deleted","type":["string","null"]},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the restore started"},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When it finished or was cancelled"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"When it was requested"}},"required":["id","orgId","sourceDbInstanceId","targetDbInstanceId","recoveryTarget","recoveryTargetTime","recoveryTargetLabel","baseBackupLabel","status","error","requestedByIamUserId","startedAt","finishedAt","createdAt"],"additionalProperties":false}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:RestoreDBInstance","x-ews-mutates":true,"x-ews-sensitive":false}},"/rds/api/server-types":{"get":{"operationId":"rds.server-types.list","summary":"List available database instance classes","description":"`rds:DescribeDBInstances` List available database instance classes.","tags":["Postgres"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Instance type name, e.g. performance-2"},"description":{"type":"string","description":"What the type is"},"vcpu":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"vCPUs"},"memoryGib":{"type":"number","description":"Memory, GiB"},"diskGib":{"type":"number","description":"The machine's own disk, GiB (the data volume is separate)"},"cpuType":{"type":"string","enum":["shared","dedicated"],"description":"Shared or dedicated vCPUs"},"priceEuroCentsHourly":{"type":"number","description":"Price per node per hour, euro cents"},"priceEuroCentsMonthly":{"type":"number","description":"Price per node per month, euro cents"},"clusterCapable":{"type":"boolean","description":"Has the 8 GiB of memory or more a cluster node needs"},"inStock":{"description":"Purchasable in the region's default zone now; null: not checked","type":["boolean","null"]},"zones":{"description":"Stock per zone; absent when not checked","type":"array","items":{"type":"object","properties":{"zoneId":{"type":"string","description":"Zone, e.g. de1a"},"inStock":{"description":"Purchasable there now; null: not known","type":["boolean","null"]},"changedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the stock last changed there"}},"required":["zoneId","inStock","changedAt"],"additionalProperties":false}}},"required":["id","description","vcpu","memoryGib","diskGib","cpuType","priceEuroCentsHourly","priceEuroCentsMonthly","clusterCapable","inStock"],"additionalProperties":false}}}}]}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"rds:DescribeDBInstances","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/access-keys":{"get":{"operationId":"s3.access-keys.list","summary":"List S3 access keys (ids and status, never secrets)","description":"`s3:ListAccessKeys` List S3 access keys (ids and status, never secrets).","tags":["Object Storage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListAccessKeys","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"s3.access-keys.create","summary":"Create an S3 access key","description":"`s3:CreateAccessKey` Create an S3 access key. The secretAccessKey is in this response and nowhere else; store it now. The key acts as the calling IAM user.","tags":["Object Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"What the key is for","type":"string","maxLength":200}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:CreateAccessKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/access-keys/{id}":{"delete":{"operationId":"s3.access-keys.delete","summary":"Delete an S3 access key","description":"`s3:DeleteAccessKey` Delete an S3 access key.","tags":["Object Storage"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Access key id (uuid), not the access key id string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteAccessKey","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets":{"get":{"operationId":"s3.buckets.list","summary":"List buckets, with the S3 endpoint to point clients at","description":"`s3:ListBuckets` List buckets, with the S3 endpoint to point clients at. Answers { buckets, endpoint }. Buckets a database created for its backups carry managedBy: \"rds\".","tags":["Object Storage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListBuckets","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"s3.buckets.create","summary":"Create a bucket","description":"`s3:CreateBucket` Create a bucket. Bucket names are shared by everyone on the platform: 409 when the name is taken or the organization is at its bucket limit.","tags":["Object Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Globally unique: 3–63 lowercase letters, digits and hyphens, no dots"},"objectLock":{"description":"Enable object lock, and with it versioning, for good. Only possible at creation","type":"boolean"},"zone":{"description":"Zone the bytes live in, e.g. de1a (Falkenstein) or de1b (Nuremberg); the region default when omitted. Fixed for good","type":"string","maxLength":16},"kmsKeyId":{"description":"KMS key that encrypts the objects (SSE-KMS); the platform key (SSE-S3) when omitted. Needs kms:Encrypt on it","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:CreateBucket","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}":{"get":{"operationId":"s3.buckets.get","summary":"One bucket with its path-style and virtual-hosted URLs","description":"`s3:GetBucket` One bucket with its path-style and virtual-hosted URLs.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucket","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"s3.buckets.delete","summary":"Delete an empty bucket","description":"`s3:DeleteBucket` Delete an empty bucket. Refused (409) while it holds objects or old object versions, and for a bucket a database manages (it goes with the database).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteBucket","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/cors":{"get":{"operationId":"s3.bucket-cors.get","summary":"The bucket’s CORS rules; null when it has none","description":"`s3:GetBucketCORS` The bucket’s CORS rules; null when it has none.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketCORS","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-cors.set","summary":"Replace the bucket’s CORS rules","description":"`s3:PutBucketCORS` Replace the bucket’s CORS rules. The same rules `aws s3api put-bucket-cors` writes over the S3 API, for every bucket. The gateway answers browser preflights (OPTIONS) from them and adds Access-Control-* headers to matching responses, presigned URLs included. Example: --rules '{\"allowedOrigins\":[\"https://app.example.com\"],\"allowedMethods\":[\"GET\",\"PUT\"],\"allowedHeaders\":[\"*\"],\"exposeHeaders\":[\"ETag\"],\"maxAgeSeconds\":3000}'","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255},"allowedOrigins":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"allowedMethods":{"minItems":1,"type":"array","items":{"type":"string","enum":["GET","PUT","POST","DELETE","HEAD"]}},"allowedHeaders":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"exposeHeaders":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"maxAgeSeconds":{"type":"integer","minimum":0,"maximum":86400}},"required":["allowedOrigins","allowedMethods"]},"description":"The rules, replacing the current ones: { allowedOrigins, allowedMethods, allowedHeaders?, exposeHeaders?, maxAgeSeconds?, id? }; the first rule that matches a request applies"}},"required":["rules"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketCORS","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-cors.delete","summary":"Remove every CORS rule: browsers on other sites can no longer call the bucket","description":"`s3:PutBucketCORS` Remove every CORS rule: browsers on other sites can no longer call the bucket.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketCORS","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/empty":{"post":{"operationId":"s3.bucket-objects.empty","summary":"Empty the bucket in the background: every object, version and delete marker, for good","description":"`s3:DeleteObjectVersion` Empty the bucket in the background: every object, version and delete marker, for good. Answers 202 with the job ({ id, status, total, deleted, failed, errors, remaining, perSecond, … }), or 200 with the one already running. total: what the bucket held when it started (counted first); when it finishes, deleted is total less remaining. Each version is still checked against your policies and the bucket policy; what they keep is counted in failed and stays. Follow it with empty-status; the bucket and its settings stay.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteObjectVersion","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"s3.bucket-objects.empty-status","summary":"The bucket’s latest empty job and how far it got","description":"`s3:ListBucketVersions` The bucket’s latest empty job and how far it got. null when the bucket was never emptied. status: queued, running, done, failed or cancelled; remaining: what the bucket still lists after it finished.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListBucketVersions","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/empty/cancel":{"post":{"operationId":"s3.bucket-objects.empty-cancel","summary":"Stop emptying the bucket; what was deleted stays deleted","description":"`s3:DeleteObjectVersion` Stop emptying the bucket; what was deleted stays deleted.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteObjectVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/encryption":{"get":{"operationId":"s3.bucket-encryption.get","summary":"Which key encrypts the bucket’s objects, and whether it is usable now","description":"`s3:GetEncryptionConfiguration` Which key encrypts the bucket’s objects, and whether it is usable now. Answers { algorithm: AES256 | aws:kms, kmsKeyId, active, usable, problem }, or { managed: true } for a bucket the platform writes.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetEncryptionConfiguration","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-encryption.set","summary":"Move the bucket to a KMS key, or back to the platform key","description":"`s3:PutEncryptionConfiguration` Move the bucket to a KMS key, or back to the platform key. Re-wraps the bucket’s one data key: every object, old and new, follows the new key at once. Disabling or deleting that KMS key makes the objects unreadable until it is enabled again (deleted: for good). Needs kms:Encrypt on the key. Also over S3: PutBucketEncryption.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kmsKeyId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"A KMS key of the organization (SSE-KMS), or null for the platform key (SSE-S3)"}},"required":["kmsKeyId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutEncryptionConfiguration","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-encryption.delete","summary":"Return the bucket to the platform key (encryption itself stays on)","description":"`s3:PutEncryptionConfiguration` Return the bucket to the platform key (encryption itself stays on).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutEncryptionConfiguration","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/lifecycle":{"get":{"operationId":"s3.bucket-lifecycle.get","summary":"The lifecycle rules","description":"`s3:GetLifecycleConfiguration` The lifecycle rules.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetLifecycleConfiguration","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-lifecycle.set","summary":"Replace the lifecycle rules","description":"`s3:PutLifecycleConfiguration` Replace the lifecycle rules. rules: [{ id, prefix?, enabled?, expirationDays?, noncurrentVersionExpirationDays?, abortIncompleteMultipartUploadDays?, expiredObjectDeleteMarker? }]. Applied by object storage once a day.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"enabled":{"default":true,"type":"boolean"},"prefix":{"default":"","type":"string","maxLength":1024},"expirationDays":{"type":"integer","minimum":1,"maximum":36500},"noncurrentVersionExpirationDays":{"type":"integer","minimum":1,"maximum":36500},"abortIncompleteMultipartUploadDays":{"type":"integer","minimum":1,"maximum":36500},"expiredObjectDeleteMarker":{"type":"boolean"}},"required":["id"]},"description":"The rules, replacing the current ones; each has its own id and at least one action (expirationDays, noncurrentVersionExpirationDays, abortIncompleteMultipartUploadDays or expiredObjectDeleteMarker)"}},"required":["rules"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutLifecycleConfiguration","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-lifecycle.delete","summary":"Remove every lifecycle rule","description":"`s3:PutLifecycleConfiguration` Remove every lifecycle rule.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutLifecycleConfiguration","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects":{"get":{"operationId":"s3.bucket-objects.list","summary":"One page (200) of objects and folders under a prefix","description":"`s3:ListObjects` One page (200) of objects and folders under a prefix. Folders are common prefixes by \"/\". Pass nextContinuationToken back for the next page. Any S3 client does the same with ListObjectsV2.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}},{"name":"prefix","in":"query","required":false,"schema":{"description":"The folder to list, e.g. photos/2026/; absent: the top level of the bucket","type":"string","maxLength":1024}},{"name":"continuationToken","in":"query","required":false,"schema":{"description":"nextContinuationToken from the previous page; absent: the first page","type":"string","maxLength":2048}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListObjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/count":{"get":{"operationId":"s3.bucket-objects.count","summary":"How many objects, older versions and delete markers a folder or the bucket holds","description":"`s3:ListBucketVersions` How many objects, older versions and delete markers a folder or the bucket holds. Answers { prefix, objects, objectBytes, olderVersions, deleteMarkers, totalBytes, complete }. Reads at most 10,000 entries; complete: false means the numbers are a floor.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}},{"name":"prefix","in":"query","required":false,"schema":{"description":"A folder ending in /; absent: the whole bucket","type":"string","maxLength":1024}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListBucketVersions","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/delete":{"post":{"operationId":"s3.bucket-objects.delete","summary":"Delete up to 1000 objects","description":"`s3:DeleteObject` Delete up to 1000 objects. Answers { deleted, errors }. A key that does not exist counts as deleted, as in S3.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":1},"description":"Keys of the objects to delete; in a versioned bucket each gets a delete marker and its versions stay"}},"required":["keys"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/delete-prefix":{"post":{"operationId":"s3.bucket-objects.delete-prefix","summary":"Delete everything under a folder; with prefix \"\" and allVersions, empty the bucket","description":"`s3:DeleteObject` Delete everything under a folder; with prefix \"\" and allVersions, empty the bucket. allVersions: true needs s3:DeleteObjectVersion and deletes every version and delete marker for good. Each call works ~20 seconds and answers { deleted, failed, errors, done, cursor }; while done is false, call again with cursor. A key your policies keep is reported in errors and stays.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"type":"string","maxLength":1024,"description":"A folder ending in /; \"\" is the whole bucket"},"allVersions":{"type":"boolean","description":"true: every version and delete marker, for good (Empty bucket). false: the current objects, as Delete does (a versioned bucket keeps them as old versions)"},"cursor":{"description":"From the previous answer, when it said done: false","type":"object","properties":{"keyMarker":{"type":"string","maxLength":1024},"versionIdMarker":{"type":"string","maxLength":1024},"continuationToken":{"type":"string","maxLength":2048}}}},"required":["prefix","allVersions"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/delete-versions":{"post":{"operationId":"s3.bucket-objects.delete-versions","summary":"Delete up to 1000 versions for good; deleting a delete marker undeletes","description":"`s3:DeleteObjectVersion` Delete up to 1000 versions for good; deleting a delete marker undeletes. Answers { deleted, errors }, each with key and versionId.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"versionId":{"type":"string","minLength":1,"maxLength":1024,"pattern":"^[A-Za-z0-9._\\-+=/]+$"}},"required":["key","versionId"]},"description":"The versions to delete for good, as { key, versionId }; the versionId of a delete marker undeletes the key"}},"required":["versions"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteObjectVersion","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/download-url":{"post":{"operationId":"s3.bucket-objects.download-url","summary":"A presigned GET for one object, valid 15 minutes, saved as a download","description":"`s3:GetObject` A presigned GET for one object, valid 15 minutes, saved as a download.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key of the object to download"},"versionId":{"description":"An older version; absent: the current one","type":"string","minLength":1,"maxLength":1024,"pattern":"^[A-Za-z0-9._\\-+=/]+$"}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetObject","x-ews-mutates":false,"x-ews-sensitive":true}},"/s3/api/buckets/{name}/objects/multipart":{"post":{"operationId":"s3.bucket-objects.multipart-create","summary":"Start a multipart upload (files over 5 GiB must use one)","description":"`s3:PutObject` Start a multipart upload (files over 5 GiB must use one). Answers { key, uploadId }. Then ask multipart-part-urls for presigned part URLs, PUT each part (5 MiB minimum except the last) and keep the ETag it answers, then multipart-complete. Until completed or aborted, the stored parts count as storage.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the assembled object is stored under"},"contentType":{"description":"Content-Type the object is stored with; application/octet-stream when omitted","type":"string","maxLength":255}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/multipart/abort":{"post":{"operationId":"s3.bucket-objects.multipart-abort","summary":"Abort an unfinished upload; its stored parts are deleted","description":"`s3:AbortMultipartUpload` Abort an unfinished upload; its stored parts are deleted. An upload that is gone already counts as aborted.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the upload was started for"},"uploadId":{"type":"string","minLength":1,"maxLength":1024,"description":"From multipart create"}},"required":["key","uploadId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:AbortMultipartUpload","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/multipart/complete":{"post":{"operationId":"s3.bucket-objects.multipart-complete","summary":"Assemble the stored parts into the object","description":"`s3:PutObject` Assemble the stored parts into the object.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the upload was started for"},"uploadId":{"type":"string","minLength":1,"maxLength":1024,"description":"From multipart create"},"parts":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"object","properties":{"partNumber":{"type":"integer","minimum":1,"maximum":10000},"etag":{"type":"string","minLength":1,"maxLength":256}},"required":["partNumber","etag"]},"description":"Every part, in ascending partNumber order, with the ETag its upload answered"}},"required":["key","uploadId","parts"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/multipart/part-urls":{"post":{"operationId":"s3.bucket-objects.multipart-part-urls","summary":"Presigned PUT URLs for up to 100 parts, valid 15 minutes","description":"`s3:PutObject` Presigned PUT URLs for up to 100 parts, valid 15 minutes. Send each part as the body of a PUT to its url; the answer carries the part’s ETag, which the console origin may read from the browser.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the upload was started for"},"uploadId":{"type":"string","minLength":1,"maxLength":1024,"description":"From multipart create"},"partNumbers":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"integer","minimum":1,"maximum":10000},"description":"Up to 100 part numbers (1–10000)"}},"required":["key","uploadId","partNumbers"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/multipart/parts":{"post":{"operationId":"s3.bucket-objects.multipart-parts","summary":"The parts of an unfinished upload stored so far, to resume it","description":"`s3:PutObject` The parts of an unfinished upload stored so far, to resume it. Answers { parts: [{ partNumber, etag, size }] }, every part (not paged).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the upload was started for"},"uploadId":{"type":"string","minLength":1,"maxLength":1024,"description":"From multipart create"}},"required":["key","uploadId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/restore-version":{"post":{"operationId":"s3.bucket-objects.restore-version","summary":"Make an older version the current one (copied over its key)","description":"`s3:PutObject` Make an older version the current one (copied over its key). Also needs s3:GetObjectVersion. The older version stays; the copy is a new latest version. The same as CopyObject with x-amz-copy-source: bucket/key?versionId=….","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key of the object"},"versionId":{"type":"string","minLength":1,"maxLength":1024,"pattern":"^[A-Za-z0-9._\\-+=/]+$","description":"The older version to make the current one again"}},"required":["key","versionId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/upload-url":{"post":{"operationId":"s3.bucket-objects.upload-url","summary":"A presigned PUT for one key, valid 15 minutes","description":"`s3:PutObject` A presigned PUT for one key, valid 15 minutes. Send the file as the body of a PUT to url with the returned headers (Content-Type). The console origin may read the answer from the browser; other origins need the bucket's CORS rules.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Key the file is stored under, e.g. photos/2026/cat.jpg"},"contentType":{"description":"Content-Type the object is stored with; application/octet-stream when omitted","type":"string","maxLength":255}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutObject","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/objects/versions":{"get":{"operationId":"s3.bucket-objects.list-versions","summary":"One page (200) of object versions and delete markers under a prefix","description":"`s3:ListBucketVersions` One page (200) of object versions and delete markers under a prefix. Answers { prefix, prefixes, versions: [{ key, versionId, isLatest, deleteMarker, size, lastModified }], nextKeyMarker, nextVersionIdMarker }, newest first per key. Pass both markers back for the next page.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}},{"name":"prefix","in":"query","required":false,"schema":{"description":"The folder to list, e.g. photos/2026/; absent: the top level of the bucket","type":"string","maxLength":1024}},{"name":"keyMarker","in":"query","required":false,"schema":{"description":"nextKeyMarker from the previous page; absent: the first page","type":"string","maxLength":1024}},{"name":"versionIdMarker","in":"query","required":false,"schema":{"description":"nextVersionIdMarker from the previous page, sent together with keyMarker","type":"string","maxLength":1024}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:ListBucketVersions","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/policy":{"get":{"operationId":"s3.bucket-access.get-policy","summary":"The bucket policy (null when there is none)","description":"`s3:GetBucketPolicy` The bucket policy (null when there is none).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketPolicy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-access.set-policy","summary":"Set the bucket policy (AWS grammar: the public, organizations, IAM users)","description":"`s3:PutBucketPolicy` Set the bucket policy (AWS grammar: the public, organizations, IAM users). Principal \"*\" (public), or {\"EWS\": [<org id> | rn:ews::<org>:iam:user/<id>]}; another organization needs its own IAM to allow the action too. Resources as arn:aws:s3:::<bucket>/… or EWS RNs; s3:ListBucket is accepted for s3:ListObjects. 403 when the policy would make the bucket public while blockPublicPolicy is on; 400 for a principal that does not exist.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"string","minLength":1,"maxLength":20480,"description":"The policy document as JSON text, as `aws s3api put-bucket-policy` takes it"}},"required":["policy"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketPolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-access.delete-policy","summary":"Remove the bucket policy","description":"`s3:DeleteBucketPolicy` Remove the bucket policy.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteBucketPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/public-access":{"get":{"operationId":"s3.bucket-access.get","summary":"Block Public Access flags, the policy, whether the bucket is public, the website","description":"`s3:GetBucketPolicy` Block Public Access flags, the policy, whether the bucket is public, the website. Also needs s3:GetBucketPublicAccessBlock and s3:GetBucketWebsite; get-block, get-policy and get-website each need only their own read. `public` is true when a policy grants the public and Block Public Access does not stop it.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketPolicy","x-ews-mutates":false,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/public-access-block":{"get":{"operationId":"s3.bucket-access.get-block","summary":"The four Block Public Access flags, and whether the bucket is public","description":"`s3:GetBucketPublicAccessBlock` The four Block Public Access flags, and whether the bucket is public.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketPublicAccessBlock","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-access.set-block","summary":"Set the four Block Public Access flags (all true on a new bucket)","description":"`s3:PutBucketPublicAccessBlock` Set the four Block Public Access flags (all true on a new bucket). blockPublicPolicy refuses a policy that would make the bucket public; restrictPublicBuckets makes the public statements of an existing policy have no effect. Turn both off only for a bucket meant for everyone.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"blockPublicAcls":{"type":"boolean","description":"Refuse public ACLs (Deutsche Cloud has no ACLs; stored for S3 tools)"},"ignorePublicAcls":{"type":"boolean","description":"Ignore public ACLs (Deutsche Cloud has no ACLs; stored for S3 tools)"},"blockPublicPolicy":{"type":"boolean","description":"Refuse a bucket policy that would make the bucket public"},"restrictPublicBuckets":{"type":"boolean","description":"Ignore the public statements of the bucket policy for anyone outside the organization"}},"required":["blockPublicAcls","ignorePublicAcls","blockPublicPolicy","restrictPublicBuckets"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketPublicAccessBlock","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/remote-copy":{"get":{"operationId":"s3.bucket-remote-copy.get","summary":"Whether the bucket keeps a remote copy, where, and how many keys still wait","description":"`s3:GetBucketRemoteCopy` Whether the bucket keeps a remote copy, where, and how many keys still wait. Answers { enabled, available, zone, pendingKeys, failedKeys, note }. `available` is false for a bucket whose storage keeps no copy elsewhere (platform buckets, own hosts).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketRemoteCopy","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-remote-copy.set","summary":"Turn the remote copy on (every existing object is copied too) or off","description":"`s3:PutBucketRemoteCopy` Turn the remote copy on (every existing object is copied too) or off. On by default for new buckets on a storage cluster. While the cluster is unavailable, objects are read from the copy; an object not copied yet, listings and writes answer 503 until it is back (never 404). Off: the copy is deleted after 7 days, and an outage of the cluster makes the bucket answer 503.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true: keep a copy of every object in the storage cluster’s other location; false: stop keeping one"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketRemoteCopy","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/replication":{"get":{"operationId":"s3.bucket-replication.get","summary":"The replication rules, and how many keys are pending or failed","description":"`s3:GetReplicationConfiguration` The replication rules, and how many keys are pending or failed. Answers { zone, rules, pending, failed, oldestPendingAt, lastFullScanAt, recentFailures }.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetReplicationConfiguration","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-replication.set","summary":"Replace the replication rules","description":"`s3:PutReplicationConfiguration` Replace the replication rules. rules: [{ destination, prefix?, deleteMarkerReplication? (false), existingObjects? (true), enabled?, priority?, id? }]. Both buckets need versioning Enabled; the caller also needs s3:PutObject on the destination. Two-way replication is refused. Copies start within seconds of a write; every bucket is also compared in full hourly.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"description":"An IAM role ARN as AWS tools send it; kept for S3 GetBucketReplication, otherwise ignored","anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"rules":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"priority":{"type":"integer","minimum":0,"maximum":1000000},"enabled":{"default":true,"type":"boolean"},"prefix":{"default":"","type":"string","maxLength":1024},"destination":{"type":"string","minLength":1,"maxLength":512},"deleteMarkerReplication":{"default":false,"type":"boolean"},"existingObjects":{"default":true,"type":"boolean"}},"required":["destination"]},"description":"The rules, replacing the current ones; each names a destination bucket (name, arn:aws:s3:::name or its RN)"}},"required":["rules"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutReplicationConfiguration","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-replication.delete","summary":"Stop replicating (replicas already made are kept)","description":"`s3:DeleteReplicationConfiguration` Stop replicating (replicas already made are kept).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteReplicationConfiguration","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/replication/retry":{"post":{"operationId":"s3.bucket-replication.retry","summary":"Give keys whose copy failed new attempts","description":"`s3:PutReplicationConfiguration` Give keys whose copy failed new attempts.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutReplicationConfiguration","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/versioning":{"get":{"operationId":"s3.bucket-versioning.get","summary":"Versioning status: Enabled, Suspended or Off","description":"`s3:GetBucketVersioning` Versioning status: Enabled, Suspended or Off.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketVersioning","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-versioning.set","summary":"Enable or suspend versioning (it can never be removed)","description":"`s3:PutBucketVersioning` Enable or suspend versioning (it can never be removed).","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true: Enabled; false: Suspended"}},"required":["enabled"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketVersioning","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/website":{"get":{"operationId":"s3.bucket-access.get-website","summary":"The website configuration (null when off), its host and custom domains","description":"`s3:GetBucketWebsite` The website configuration (null when off), its host and custom domains.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:GetBucketWebsite","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"s3.bucket-access.set-website","summary":"Serve the bucket as a static website on https://<bucket>.s3-website.<root>","description":"`s3:PutBucketWebsite` Serve the bucket as a static website on https://<bucket>.s3-website.<root>. Only objects the bucket policy makes public are served; anything else answers 403.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"indexDocument":{"description":"Index document suffix, e.g. index.html; required unless redirectAllRequestsTo","type":"string","minLength":1,"maxLength":255},"redirectAllRequestsTo":{"description":"{ hostName, protocol? }: send every request, path and query kept, to another host","type":"object","properties":{"hostName":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(:\\d{1,5})?$"},"protocol":{"type":"string","enum":["http","https"]}},"required":["hostName"],"additionalProperties":false},"routingRules":{"description":"AWS RoutingRules: [{ condition?: { keyPrefixEquals?, httpErrorCodeReturnedEquals? }, redirect: { hostName?, protocol?, replaceKeyPrefixWith? | replaceKeyWith?, httpRedirectCode? } }]","maxItems":50,"type":"array","items":{"type":"object","properties":{"condition":{"type":"object","properties":{"keyPrefixEquals":{"type":"string","maxLength":1024},"httpErrorCodeReturnedEquals":{"type":"string","pattern":"^[45]\\d\\d$"}}},"redirect":{"type":"object","properties":{"hostName":{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(:\\d{1,5})?$"},"protocol":{"type":"string","enum":["http","https"]},"replaceKeyPrefixWith":{"type":"string","maxLength":1024},"replaceKeyWith":{"type":"string","maxLength":1024},"httpRedirectCode":{"type":"string","enum":["301","302","303","307","308"]}}}},"required":["redirect"],"additionalProperties":false}},"errorDocument":{"description":"Key served with 404 for a missing page, e.g. 404.html","anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketWebsite","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"s3.bucket-access.delete-website","summary":"Stop serving the bucket as a website","description":"`s3:DeleteBucketWebsite` Stop serving the bucket as a website.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteBucketWebsite","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/website/domains":{"post":{"operationId":"s3.bucket-access.add-domain","summary":"Answer the website on a domain of your own","description":"`s3:PutBucketWebsite` Answer the website on a domain of your own. Returns the CNAME to create. In a zone hosted in Deutsche Cloud DNS an ALIAS record is written instead (aliasRecordCreated: true). The certificate is issued on the first HTTPS visit.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"description":"A domain of your own, e.g. www.example.com","type":"string"}},"required":["domain"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:PutBucketWebsite","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/buckets/{name}/website/domains/{domain}":{"delete":{"operationId":"s3.bucket-access.remove-domain","summary":"Remove a custom domain from the website","description":"`s3:DeleteBucketWebsite` Remove a custom domain from the website.","tags":["Object Storage"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","description":"Bucket name"}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","description":"The custom domain"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:DeleteBucketWebsite","x-ews-mutates":true,"x-ews-sensitive":false}},"/s3/api/temporary-credentials":{"post":{"operationId":"s3.temporary-credentials.create","summary":"Create temporary S3 credentials (15 minutes to 12 hours, default 1 hour)","description":"`s3:CreateTemporaryCredentials` Create temporary S3 credentials (15 minutes to 12 hours, default 1 hour). Returns accessKeyId, secretAccessKey, sessionToken and expiresAt once. Every S3 request must carry the token as a signed x-amz-security-token (AWS_SESSION_TOKEN in the AWS CLI and SDKs). They are never listed and cannot be revoked; they expire.","tags":["Object Storage"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"durationSeconds":{"description":"Lifetime in seconds, 900–43200 (default 3600)","type":"integer","minimum":900,"maximum":43200},"description":{"description":"What the credentials are for","type":"string","maxLength":200}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"s3:CreateTemporaryCredentials","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/pools":{"get":{"operationId":"sandbox.pools.list","summary":"List warm pools: image, size class, ready instances, claims","description":"`sandbox:DescribePools` List warm pools: image, size class, ready instances, claims.","tags":["Sandboxes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:DescribePools","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"sandbox.pools.create","summary":"Keep sandboxes of one image and size started","description":"`sandbox:CreatePool` Keep sandboxes of one image and size started. Warm instances reserve memory on the organization’s sandbox host (a host boots for it if there is none) and are billed like running sandboxes. A create with the same image (or runtime), memoryMb, vcpu, diskMb and network mode claims one; allowlist sandboxes always start cold. At most 3 pools, 10 instances each, in the preview.","tags":["Sandboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"runtime":{"description":"A stock runtime (or give image)","type":"string","enum":["python3.12","nodejs22"]},"image":{"type":"string","minLength":1,"maxLength":300,"pattern":"^[a-z0-9][a-z0-9._\\-/:@]*$","description":"An image of this organization’s registry (repo:tag or repo@sha256:…), pinned to its digest at create. Its Env applies to every command; its ENTRYPOINT/CMD do not run; commands run as uid 65534; it needs /bin/sh"},"memoryMb":{"description":"Memory in MB of each sandbox (default 512); a create must ask for the same to claim one","type":"integer","minimum":256,"maximum":4096},"vcpu":{"type":"number","minimum":0.5,"maximum":4},"diskMb":{"type":"integer","minimum":512,"maximum":10240},"networkMode":{"description":"none (default) or open (needs sandbox:UseOpenEgress); allowlist sandboxes start cold","type":"string","enum":["none","open"]},"size":{"description":"How many to keep started (0–10); with autoscale, the starting size (default its min)","type":"integer","minimum":0,"maximum":10},"autoscale":{"type":"object","properties":{"min":{"type":"integer","minimum":0,"maximum":10},"max":{"type":"integer","minimum":1,"maximum":10}},"required":["min","max"],"description":"Size the pool by the creates that match it: between min and max, the most matching creates within any 10 s of the last 15 min (or the steady rate × refill time × 2, if more). Up at once, down by at most half per minute. Each warm instance is billed; size is then read-only"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:CreatePool","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["ecr:PullImage","sandbox:UseOpenEgress"]}},"/sandbox/api/pools/{poolId}":{"get":{"operationId":"sandbox.pools.get","summary":"Read a warm pool","description":"`sandbox:DescribePools` Read a warm pool.","tags":["Sandboxes"],"parameters":[{"name":"poolId","in":"path","required":true,"schema":{"type":"string","pattern":"^pool-[0-9a-f]{12}$","description":"Warm pool id (pool-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:DescribePools","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"sandbox.pools.update","summary":"Resize a warm pool, turn its autoscaling on or off, or move it to a new image (its warm instances are replaced)","description":"`sandbox:UpdatePool` Resize a warm pool, turn its autoscaling on or off, or move it to a new image (its warm instances are replaced).","tags":["Sandboxes"],"parameters":[{"name":"poolId","in":"path","required":true,"schema":{"type":"string","pattern":"^pool-[0-9a-f]{12}$","description":"Warm pool id (pool-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"size":{"type":"integer","minimum":0,"maximum":10,"description":"How many to keep started (0–10); each is billed like a running sandbox while warm"},"image":{"description":"A new image (re-resolved to its digest): the warm instances are replaced","type":"string","minLength":1,"maxLength":300,"pattern":"^[a-z0-9][a-z0-9._\\-/:@]*$"},"autoscale":{"description":"Turn autoscaling on ({min, max}) or off (null: the current size stays, now yours)","anyOf":[{"type":"object","properties":{"min":{"type":"integer","minimum":0,"maximum":10},"max":{"type":"integer","minimum":1,"maximum":10}},"required":["min","max"],"description":"Size the pool by the creates that match it: between min and max, the most matching creates within any 10 s of the last 15 min (or the steady rate × refill time × 2, if more). Up at once, down by at most half per minute. Each warm instance is billed; size is then read-only"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:UpdatePool","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["ecr:PullImage"]},"delete":{"operationId":"sandbox.pools.delete","summary":"Delete a warm pool (sandboxes that claimed from it keep running)","description":"`sandbox:DeletePool` Delete a warm pool (sandboxes that claimed from it keep running).","tags":["Sandboxes"],"parameters":[{"name":"poolId","in":"path","required":true,"schema":{"type":"string","pattern":"^pool-[0-9a-f]{12}$","description":"Warm pool id (pool-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:DeletePool","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes":{"get":{"operationId":"sandbox.sandboxes.list","summary":"List sandboxes, and the organization’s sandbox hosts","description":"`sandbox:DescribeSandboxes` List sandboxes, and the organization’s sandbox hosts.","tags":["Sandboxes"],"parameters":[{"name":"state","in":"query","required":false,"schema":{"description":"active (default): pending and running; all: also the last day of ended ones","type":"string","enum":["active","all"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:DescribeSandboxes","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"sandbox.sandboxes.create","summary":"Start a sandbox from a stock runtime or an image of your registry","description":"`sandbox:CreateSandbox` Start a sandbox from a stock runtime or an image of your registry. Answers 201 with state running, or 202 with state pending (the organization’s first sandbox waits about a minute for its own sandbox host, and an image is pulled once per host; get it again until it runs). image (repo:tag or repo@sha256:…, your own registry, needs ecr:PullImage) is pinned to its digest; its Env applies, its ENTRYPOINT/CMD do not run, commands run as uid 65534. A create matching a warm pool (same image or runtime, memoryMb, vcpu, diskMb, network mode) claims a started one: startMode pool. Network defaults to none; open needs sandbox:UseOpenEgress. Files live in /workspace (an ext4 volume of diskMb) and survive a restart of the host, not its replacement. It ends after timeoutSeconds, or idleTimeoutSeconds without an exec, file call, open terminal or port request.","tags":["Sandboxes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"runtime":{"description":"python3.12 (default) or nodejs22: the stock Debian-slim images (or give image)","type":"string","enum":["python3.12","nodejs22"]},"image":{"type":"string","minLength":1,"maxLength":300,"pattern":"^[a-z0-9][a-z0-9._\\-/:@]*$","description":"An image of this organization’s registry (repo:tag or repo@sha256:…), pinned to its digest at create. Its Env applies to every command; its ENTRYPOINT/CMD do not run; commands run as uid 65534; it needs /bin/sh"},"ports":{"description":"Ports to expose at once on https://<port>-<id>.sbx.apps.<root> (at most 5)","maxItems":5,"type":"array","items":{"type":"object","properties":{"port":{"type":"integer","minimum":1024,"maximum":65535,"description":"A port the sandbox listens on (1024–65535)"},"auth":{"description":"private (default): a port token is needed (open-port gives a link). public: anyone with the URL (needs sandbox:ExposePublicPort)","type":"string","enum":["private","public"]}},"required":["port"]}},"memoryMb":{"description":"Memory in MB (256–4096, default 512)","type":"integer","minimum":256,"maximum":4096},"vcpu":{"description":"vCPU (0.5–4); default memory/1 GB, at least 0.5","type":"number","minimum":0.5,"maximum":4},"diskMb":{"description":"Workspace size in MB (512–10240, default 2048); writes beyond it fail","type":"integer","minimum":512,"maximum":10240},"timeoutSeconds":{"description":"Lifetime in seconds (60–86400, default 3600); extend it with update","type":"integer","minimum":60,"maximum":86400},"idleTimeoutSeconds":{"description":"Stop after this many seconds without an exec or file call (default 900; 0 = off)","type":"integer","minimum":0,"maximum":86400},"network":{"type":"object","properties":{"mode":{"type":"string","enum":["none","allowlist","open"],"description":"none (default): no network at all. allowlist: only the names in allow, over HTTPS/HTTP. open: the internet minus private ranges and SMTP (needs sandbox:UseOpenEgress)"},"allow":{"description":"allowlist mode: host names, .suffixes, or the preset package-registries (PyPI, npm, crates, Go, Debian/Ubuntu/Alpine, GitHub, GitLab)","maxItems":100,"type":"array","items":{"type":"string","maxLength":253,"pattern":"^(package-registries|\\.?([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63})$"}}},"required":["mode"]},"metadata":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64},"additionalProperties":{"type":"string","maxLength":256}},"waitSeconds":{"description":"Wait up to this long for the sandbox to run (default 30). The first sandbox of an organization waits for its sandbox host (about a minute)","type":"integer","minimum":0,"maximum":120}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:CreateSandbox","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["sandbox:UseOpenEgress","ecr:PullImage","sandbox:ExposePort","sandbox:ExposePublicPort"]}},"/sandbox/api/sandboxes/{id}":{"get":{"operationId":"sandbox.sandboxes.get","summary":"Read a sandbox: state and why, limits, network, host, deadlines, usage","description":"`sandbox:DescribeSandboxes` Read a sandbox: state and why, limits, network, host, deadlines, usage.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:DescribeSandboxes","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"sandbox.sandboxes.update","summary":"Extend a sandbox’s lifetime, change its idle timeout or metadata","description":"`sandbox:UpdateSandbox` Extend a sandbox’s lifetime, change its idle timeout or metadata.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"timeoutSeconds":{"description":"New lifetime, counted from now (60–86400)","type":"integer","minimum":60,"maximum":86400},"idleTimeoutSeconds":{"type":"integer","minimum":0,"maximum":86400},"metadata":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64},"additionalProperties":{"type":"string","maxLength":256}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:UpdateSandbox","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"sandbox.sandboxes.delete","summary":"Stop a sandbox; its processes and workspace are discarded","description":"`sandbox:TerminateSandbox` Stop a sandbox; its processes and workspace are discarded.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:TerminateSandbox","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes/{id}/connect":{"post":{"operationId":"sandbox.sandboxes.connect","summary":"Mint a short-lived token for the sandbox host’s data plane (lower latency, files up to 100 MB, the terminal)","description":"`sandbox:ConnectSandbox` Mint a short-lived token for the sandbox host’s data plane (lower latency, files up to 100 MB, the terminal). Returns {url, token}: POST {url}/exec, GET/PUT {url}/files?path=, GET {url}/files/list, with Authorization: Bearer {token}. With scope terminal: a WebSocket at wss://…/pty (subprotocols ews.terminal and ews.token.{token}) is an interactive shell; `dcloud sandbox shell <id>` does this for you. Each scope needs the matching action. The mint is audited; calls with the token are logged to the sandbox log (a terminal: its open and close, not keystrokes).","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scopes":{"description":"What the token may do (default exec, files:read, files:write); each needs the matching action: ExecCommand, ReadFiles, WriteFiles, StartTerminal","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["exec","files:read","files:write","terminal"]}},"ttlSeconds":{"description":"Token lifetime (60–3600, default 900); never beyond the sandbox","type":"integer","minimum":60,"maximum":3600}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ConnectSandbox","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["sandbox:ExecCommand","sandbox:ReadFiles","sandbox:WriteFiles","sandbox:StartTerminal"]}},"/sandbox/api/sandboxes/{id}/exec":{"post":{"operationId":"sandbox.sandboxes.exec","summary":"Run a command in a sandbox and return its output and exit code","description":"`sandbox:ExecCommand` Run a command in a sandbox and return its output and exit code. cmd is argv ([\"python3\",\"-c\",\"print(1)\"]); command is a shell line (sh -c). Runs as an unprivileged user in /workspace. Output is cut to 256 KB per stream through the API (head and tail kept, truncated: true). Each call is audited; the command line also goes to the sandbox log.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cmd":{"description":"The program and its arguments, e.g. [\"python3\", \"-c\", \"print(1)\"]","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","maxLength":65536}},"command":{"description":"A shell command line, run as sh -c (instead of cmd)","type":"string","minLength":1,"maxLength":65536},"stdin":{"type":"string","maxLength":1048576},"env":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$"},"additionalProperties":{"type":"string","maxLength":65536}},"cwd":{"description":"Working directory (default /workspace)","type":"string","maxLength":4096},"timeoutMs":{"description":"Stop the command after this long (default 60000, at most 30 minutes)","type":"integer","minimum":100,"maximum":1800000}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ExecCommand","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes/{id}/files":{"get":{"operationId":"sandbox.files.read","summary":"Download a file from a sandbox (text as content, binary as contentBase64)","description":"`sandbox:ReadFiles` Download a file from a sandbox (text as content, binary as contentBase64).","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":4096,"description":"A path in the workspace: /workspace/data.csv or data.csv"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ReadFiles","x-ews-mutates":false,"x-ews-sensitive":true},"put":{"operationId":"sandbox.files.write","summary":"Upload a file into a sandbox, making its directories","description":"`sandbox:WriteFiles` Upload a file into a sandbox, making its directories.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":4096,"description":"A path in the workspace: /workspace/data.csv or data.csv"},"content":{"description":"The file as UTF-8 text","type":"string"},"contentBase64":{"description":"The file as base64 (binary files)","type":"string"}},"required":["path"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:WriteFiles","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes/{id}/files/list":{"get":{"operationId":"sandbox.files.list","summary":"List a directory of a sandbox’s workspace","description":"`sandbox:ReadFiles` List a directory of a sandbox’s workspace.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"path","in":"query","required":false,"schema":{"description":"A directory (default /workspace)","type":"string","minLength":1,"maxLength":4096}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ReadFiles","x-ews-mutates":false,"x-ews-sensitive":true}},"/sandbox/api/sandboxes/{id}/fork":{"post":{"operationId":"sandbox.sandboxes.fork","summary":"Copy a running sandbox, memory and workspace, into a new sandbox","description":"`sandbox:ForkSandbox` Copy a running sandbox, memory and workspace, into a new sandbox. Needs sandbox:CreateSandbox too. The copy keeps running processes and /tmp, inherits the network policy and size, runs on the same host and gets a fresh lifetime. It counts against the sandbox quota.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ForkSandbox","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes/{id}/logs":{"get":{"operationId":"sandbox.sandboxes.logs","summary":"Read a sandbox’s log: commands, file transfers, starts, restarts, denied lookups","description":"`sandbox:GetSandboxLogs` Read a sandbox’s log: commands, file transfers, starts, restarts, denied lookups.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"contains","in":"query","required":false,"schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:GetSandboxLogs","x-ews-mutates":false,"x-ews-sensitive":true}},"/sandbox/api/sandboxes/{id}/ports/{port}":{"put":{"operationId":"sandbox.ports.expose","summary":"Expose a port of a sandbox on its own URL (private unless auth is public)","description":"`sandbox:ExposePort` Expose a port of a sandbox on its own URL (private unless auth is public). The URL resolves within about 20 seconds. Something in the sandbox must listen on 0.0.0.0:<port>; until then the URL answers 502. A sandbox with network none still takes requests on its exposed ports. At most 5 per sandbox.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"port","in":"path","required":true,"schema":{"type":"integer","minimum":1024,"maximum":65535,"description":"Port (1024–65535)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"description":"private (default): a port token is needed. public: anyone with the URL (needs sandbox:ExposePublicPort)","type":"string","enum":["private","public"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ExposePort","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["sandbox:ExposePublicPort"]},"delete":{"operationId":"sandbox.ports.close","summary":"Stop exposing a port","description":"`sandbox:ExposePort` Stop exposing a port.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"port","in":"path","required":true,"schema":{"type":"integer","minimum":1024,"maximum":65535,"description":"Port (1024–65535)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ExposePort","x-ews-mutates":true,"x-ews-sensitive":false}},"/sandbox/api/sandboxes/{id}/ports/{port}/open":{"post":{"operationId":"sandbox.ports.open","summary":"Get a link to a private port (a short-lived token bound to this port)","description":"`sandbox:ConnectSandbox` Get a link to a private port (a short-lived token bound to this port). Opening the link in a browser sets a cookie for that host name and drops the token from the address. A program sends Authorization: Bearer {token}. The token opens this one port of this one sandbox.","tags":["Sandboxes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^sbx-[0-9a-f]{12}$","description":"Sandbox id (sbx-…)"}},{"name":"port","in":"path","required":true,"schema":{"type":"integer","minimum":1024,"maximum":65535,"description":"Port (1024–65535)"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ttlSeconds":{"description":"How long the link (and the cookie it leaves) opens the port: 60–3600 s, default 900","type":"integer","minimum":60,"maximum":3600}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"sandbox:ConnectSandbox","x-ews-mutates":true,"x-ews-sensitive":false}},"/scheduler/api/preview":{"get":{"operationId":"scheduler.schedules.preview","summary":"Show when an expression would fire, in a time zone, without saving anything","description":"`scheduler:ListSchedules` Show when an expression would fire, in a time zone, without saving anything.","tags":["Schedules"],"parameters":[{"name":"expression","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":256,"description":"cron(minute hour day-of-month month day-of-week), rate(n minutes|hours|days) or at(yyyy-mm-ddThh:mm:ss)"}},{"name":"timezone","in":"query","required":false,"schema":{"default":"UTC","type":"string","minLength":1,"maxLength":64,"description":"IANA time zone the expression is read in, e.g. Europe/Berlin"}},{"name":"startDate","in":"query","required":false,"schema":{}},{"name":"endDate","in":"query","required":false,"schema":{}},{"name":"count","in":"query","required":false,"schema":{"default":10,"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:ListSchedules","x-ews-mutates":false,"x-ews-sensitive":false}},"/scheduler/api/schedules":{"get":{"operationId":"scheduler.schedules.list","summary":"List schedules with their next runs, health and last invocation","description":"`scheduler:ListSchedules` List schedules with their next runs, health and last invocation.","tags":["Schedules"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:ListSchedules","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"scheduler.schedules.create","summary":"Create a schedule","description":"`scheduler:CreateSchedule` Create a schedule. expression: cron(minute hour day-of-month month day-of-week) on the wall clock of timezone, rate(n minutes|hours|days), or at(yyyy-mm-ddThh:mm:ss). target is one of: {type:\"http\", url, method?, headers?, input?, timeoutSeconds?} (signed with the schedule’s secret: X-EWS-Signature-256 = sha256 HMAC of \"<X-EWS-Timestamp>.<body>\"); {type:\"queue\", queueName, input?, messageGroupId?}; {type:\"ci\", repositoryId, path, ref?, inputs?} (workflow_dispatch / on.manual); {type:\"app_job\", appId, jobName} (runs an existing app job through the deploy agent; the invocation waits for its exit code); {type:\"function\", functionName, input?} (POSTs input to the function; 2xx is success). queue, ci, app_job and function act as roleName (also needs iam:PassRole on it); so does a deadLetterQueue. Every invocation is attempted 1 + retryMaxAttempts times with exponential backoff (5xx, 429, timeouts, a failed job run), never past maxEventAgeSeconds; a final failure goes to deadLetterQueue. failureAlarm creates a monitoring alarm on EWS/Scheduler InvocationsFailed for this schedule. 409 when the name is taken.","tags":["Schedules"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"expression":{"type":"string","minLength":1,"maxLength":256,"description":"cron(minute hour day-of-month month day-of-week), rate(n minutes|hours|days) or at(yyyy-mm-ddThh:mm:ss)"},"timezone":{"type":"string","minLength":1,"maxLength":64,"description":"IANA time zone the expression is read in, e.g. Europe/Berlin"},"startDate":{"description":"Nothing fires before this (ISO 8601)","anyOf":[{},{"type":"null"}]},"endDate":{"description":"Nothing fires after this (ISO 8601)","anyOf":[{},{"type":"null"}]},"state":{"type":"string","enum":["enabled","disabled"]},"flexibleWindowMinutes":{"description":"Fire at a random moment up to this many minutes after each tick (0 = exactly on it)","type":"integer","minimum":0,"maximum":1440},"catchUp":{"description":"Ticks missed while the scheduler was down: none skips them, latest (default) fires the most recent once, all fires each (≤ 100, within maxEventAgeSeconds)","type":"string","enum":["none","latest","all"]},"actionAfterCompletion":{"description":"For at(): keep the schedule after it fired (none) or delete it","type":"string","enum":["none","delete"]},"target":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"http"},"url":{"type":"string","maxLength":2048,"description":"https URL on a public address; redirects are not followed"},"method":{"default":"POST","type":"string","enum":["POST","PUT","PATCH","GET"]},"headers":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9-]+$"},"additionalProperties":{"type":"string","maxLength":1000}},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"},"timeoutSeconds":{"default":10,"type":"integer","minimum":1,"maximum":30}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","const":"queue"},"queueName":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"},"messageGroupId":{"type":"string","minLength":1,"maxLength":128}},"required":["type","queueName"]},{"type":"object","properties":{"type":{"type":"string","const":"ci"},"repositoryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository whose workflow is started"},"path":{"type":"string","minLength":1,"maxLength":500,"description":"Workflow file, e.g. .github/workflows/nightly.yml"},"ref":{"description":"Branch or tag; the default branch when absent","type":"string","minLength":1,"maxLength":250},"inputs":{"description":"workflow_dispatch inputs; values take the same <ews.scheduler.*> placeholders","type":"object","propertyNames":{"type":"string","maxLength":100},"additionalProperties":{"type":"string","maxLength":10000}}},"required":["type","repositoryId","path"]},{"type":"object","properties":{"type":{"type":"string","const":"app_job"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"jobName":{"type":"string","minLength":1,"maxLength":63,"description":"A job of the app; set it to enabled: false to run it only from this schedule"}},"required":["type","appId","jobName"]},{"type":"object","properties":{"type":{"type":"string","const":"function"},"functionName":{"type":"string","minLength":1,"maxLength":128},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"}},"required":["type","functionName"]}]},"roleName":{"description":"IAM role the invocations act as; needs iam:PassRole on it. Required for queue, ci and app_job targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"retryMaxAttempts":{"type":"integer","minimum":0,"maximum":20},"retryBackoffSeconds":{"description":"First retry after this, doubling each time (±20 %, at most 15 minutes)","type":"integer","minimum":5,"maximum":3600},"maxEventAgeSeconds":{"description":"An invocation older than this is not attempted again","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed invocation is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]},"failureAlarm":{"description":"Creates and keeps a monitoring alarm on this schedule’s failed invocations; null removes it","anyOf":[{"type":"object","properties":{"notifyEmails":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]}}},{"type":"null"}]}},"required":["name","expression","target"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:CreateSchedule","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:PassRole","monitoring:PutMetricAlarm"]}},"/scheduler/api/schedules/{name}":{"get":{"operationId":"scheduler.schedules.get","summary":"Read a schedule","description":"`scheduler:GetSchedule` Read a schedule.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:GetSchedule","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"scheduler.schedules.update","summary":"Change a schedule, or enable or disable it (state)","description":"`scheduler:UpdateSchedule` Change a schedule, or enable or disable it (state). The name cannot change. Changing the expression, time zone or dates, or enabling it, recomputes the next run from now (a disabled spell is not caught up). target is one of: {type:\"http\", url, method?, headers?, input?, timeoutSeconds?} (signed with the schedule’s secret: X-EWS-Signature-256 = sha256 HMAC of \"<X-EWS-Timestamp>.<body>\"); {type:\"queue\", queueName, input?, messageGroupId?}; {type:\"ci\", repositoryId, path, ref?, inputs?} (workflow_dispatch / on.manual); {type:\"app_job\", appId, jobName} (runs an existing app job through the deploy agent; the invocation waits for its exit code); {type:\"function\", functionName, input?} (POSTs input to the function; 2xx is success). queue, ci, app_job and function act as roleName (also needs iam:PassRole on it); so does a deadLetterQueue. Every invocation is attempted 1 + retryMaxAttempts times with exponential backoff (5xx, 429, timeouts, a failed job run), never past maxEventAgeSeconds; a final failure goes to deadLetterQueue.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}]},"expression":{"type":"string","minLength":1,"maxLength":256,"description":"cron(minute hour day-of-month month day-of-week), rate(n minutes|hours|days) or at(yyyy-mm-ddThh:mm:ss)"},"timezone":{"type":"string","minLength":1,"maxLength":64,"description":"IANA time zone the expression is read in, e.g. Europe/Berlin"},"startDate":{"description":"Nothing fires before this (ISO 8601)","anyOf":[{},{"type":"null"}]},"endDate":{"description":"Nothing fires after this (ISO 8601)","anyOf":[{},{"type":"null"}]},"state":{"type":"string","enum":["enabled","disabled"]},"flexibleWindowMinutes":{"description":"Fire at a random moment up to this many minutes after each tick (0 = exactly on it)","type":"integer","minimum":0,"maximum":1440},"catchUp":{"description":"Ticks missed while the scheduler was down: none skips them, latest (default) fires the most recent once, all fires each (≤ 100, within maxEventAgeSeconds)","type":"string","enum":["none","latest","all"]},"actionAfterCompletion":{"description":"For at(): keep the schedule after it fired (none) or delete it","type":"string","enum":["none","delete"]},"target":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"http"},"url":{"type":"string","maxLength":2048,"description":"https URL on a public address; redirects are not followed"},"method":{"default":"POST","type":"string","enum":["POST","PUT","PATCH","GET"]},"headers":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9-]+$"},"additionalProperties":{"type":"string","maxLength":1000}},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"},"timeoutSeconds":{"default":10,"type":"integer","minimum":1,"maximum":30}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","const":"queue"},"queueName":{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"},"messageGroupId":{"type":"string","minLength":1,"maxLength":128}},"required":["type","queueName"]},{"type":"object","properties":{"type":{"type":"string","const":"ci"},"repositoryId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The repository whose workflow is started"},"path":{"type":"string","minLength":1,"maxLength":500,"description":"Workflow file, e.g. .github/workflows/nightly.yml"},"ref":{"description":"Branch or tag; the default branch when absent","type":"string","minLength":1,"maxLength":250},"inputs":{"description":"workflow_dispatch inputs; values take the same <ews.scheduler.*> placeholders","type":"object","propertyNames":{"type":"string","maxLength":100},"additionalProperties":{"type":"string","maxLength":10000}}},"required":["type","repositoryId","path"]},{"type":"object","properties":{"type":{"type":"string","const":"app_job"},"appId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"jobName":{"type":"string","minLength":1,"maxLength":63,"description":"A job of the app; set it to enabled: false to run it only from this schedule"}},"required":["type","appId","jobName"]},{"type":"object","properties":{"type":{"type":"string","const":"function"},"functionName":{"type":"string","minLength":1,"maxLength":128},"input":{"type":"string","maxLength":65536,"description":"Sent to the target (HTTP body, queue message). <ews.scheduler.scheduled-time>, <ews.scheduler.execution-id>, <ews.scheduler.attempt-number> and <ews.scheduler.schedule-name> are replaced"}},"required":["type","functionName"]}]},"roleName":{"description":"IAM role the invocations act as; needs iam:PassRole on it. Required for queue, ci and app_job targets and for a dead-letter queue","anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"retryMaxAttempts":{"type":"integer","minimum":0,"maximum":20},"retryBackoffSeconds":{"description":"First retry after this, doubling each time (±20 %, at most 15 minutes)","type":"integer","minimum":5,"maximum":3600},"maxEventAgeSeconds":{"description":"An invocation older than this is not attempted again","type":"integer","minimum":60,"maximum":86400},"deadLetterQueue":{"description":"Queue a finally-failed invocation is sent to (as the role)","anyOf":[{"type":"string","maxLength":80,"pattern":"^[A-Za-z0-9_-]+(\\.fifo)?$"},{"type":"null"}]},"failureAlarm":{"description":"Creates and keeps a monitoring alarm on this schedule’s failed invocations; null removes it","anyOf":[{"type":"object","properties":{"notifyEmails":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"webhookUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]}}},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:UpdateSchedule","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["iam:PassRole","monitoring:PutMetricAlarm","monitoring:DeleteAlarms"]},"delete":{"operationId":"scheduler.schedules.delete","summary":"Delete a schedule, its invocations and the failure alarm it owns","description":"`scheduler:DeleteSchedule` Delete a schedule, its invocations and the failure alarm it owns.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:DeleteSchedule","x-ews-mutates":true,"x-ews-sensitive":false}},"/scheduler/api/schedules/{name}/invocations":{"post":{"operationId":"scheduler.schedules.invoke","summary":"Run a schedule now, through the same role, retries and dead-letter queue","description":"`scheduler:InvokeSchedule` Run a schedule now, through the same role, retries and dead-letter queue. 202 with the invocation (status pending); read it back with invocation.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:InvokeSchedule","x-ews-mutates":true,"x-ews-sensitive":false},"get":{"operationId":"scheduler.schedules.invocations","summary":"List a schedule’s invocations, newest first: status, attempts, the target’s answer","description":"`scheduler:ListInvocations` List a schedule’s invocations, newest first: status, attempts, the target’s answer.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","running","waiting","retry_wait","succeeded","failed","dead_lettered","dropped"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:ListInvocations","x-ews-mutates":false,"x-ews-sensitive":false}},"/scheduler/api/schedules/{name}/invocations/{id}":{"get":{"operationId":"scheduler.schedules.invocation","summary":"Read one invocation with its log: each attempt, the answer and the output","description":"`scheduler:ListInvocations` Read one invocation with its log: each attempt, the answer and the output.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:ListInvocations","x-ews-mutates":false,"x-ews-sensitive":false}},"/scheduler/api/schedules/{name}/signing-secret":{"get":{"operationId":"scheduler.schedules.signing-secret","summary":"Reveal the secret HTTP invocations are signed with (audited)","description":"`scheduler:GetScheduleSigningSecret` Reveal the secret HTTP invocations are signed with (audited).","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:GetScheduleSigningSecret","x-ews-mutates":false,"x-ews-sensitive":true}},"/scheduler/api/schedules/{name}/signing-secret/rotate":{"post":{"operationId":"scheduler.schedules.rotate-signing-secret","summary":"Replace the signing secret; the previous one also signs for 24 hours","description":"`scheduler:RotateScheduleSigningSecret` Replace the signing secret; the previous one also signs for 24 hours.","tags":["Schedules"],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.-]*$","description":"Schedule name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"scheduler:RotateScheduleSigningSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/apps/{appId}/environment":{"put":{"operationId":"secrets.environments.set-app-environment","summary":"Set which environment an app’s secret names resolve in (null: shared only)","description":"`deploy:UpdateApp` Set which environment an app’s secret names resolve in (null: shared only).","tags":["Secrets"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deploy app id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"environmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The environment the app’s secret names resolve in (its own secret, else the Default one), or null for Default values only. An unknown environment id is 404."}},"required":["environmentId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:UpdateApp","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/apps/{appId}/flow":{"get":{"operationId":"secrets.secrets.app-flow","summary":"List every secret an app uses, where each comes from and the version it last read","description":"`deploy:DescribeApp` List every secret an app uses, where each comes from and the version it last read. Secrets the caller may not describe (secrets:GetSecret) are left out.","tags":["Secrets"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Deploy app id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"deploy:DescribeApp","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/environments":{"get":{"operationId":"secrets.environments.list","summary":"List environments in promotion order, with their secret and app counts","description":"`secrets:ListSecretEnvironments` List environments in promotion order, with their secret and app counts. dev, staging and prod are created on first use.","tags":["Secrets"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecretEnvironments","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"secrets.environments.create","summary":"Add an environment","description":"`secrets:CreateSecretEnvironment` Add an environment.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$","description":"Short id of the environment, e.g. qa: lower-case letters, digits and hyphens, starting with a letter or digit, at most 63 characters. Unique in the organization (an existing slug is refused with 409) and cannot be changed later. Workflow jobs name an environment by it."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"Display name, e.g. QA. 1 to 64 characters."},"position":{"description":"Place in the promotion order, 0 to 10000; a higher number is later (Development 10, Staging 20, Production 30 to start with). Omitted: the last environment’s position plus 10.","type":"integer","minimum":0,"maximum":10000},"color":{"anyOf":[{"type":"string","enum":["gray","blue","teal","green","amber","red","violet"],"description":"The dot shown beside the environment: gray, blue, teal, green, amber, red or violet. Null: automatic (from the slug)."},{"type":"null"}]}},"required":["slug","name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:CreateSecretEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/environments/{id}":{"patch":{"operationId":"secrets.environments.update","summary":"Rename an environment, move it in the promotion order or change its colour","description":"`secrets:UpdateSecretEnvironment` Rename an environment, move it in the promotion order or change its colour.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Environment id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"New display name, 1 to 64 characters. Omitted: unchanged. The slug cannot change.","type":"string","minLength":1,"maxLength":64},"position":{"description":"New place in the promotion order, 0 to 10000; higher is later. Omitted: unchanged.","type":"integer","minimum":0,"maximum":10000},"color":{"anyOf":[{"type":"string","enum":["gray","blue","teal","green","amber","red","violet"],"description":"The dot shown beside the environment: gray, blue, teal, green, amber, red or violet. Null: automatic (from the slug)."},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UpdateSecretEnvironment","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"secrets.environments.delete","summary":"Delete an environment (refused while it holds secrets or apps)","description":"`secrets:DeleteSecretEnvironment` Delete an environment (refused while it holds secrets or apps).","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Environment id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:DeleteSecretEnvironment","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/environments/diff":{"get":{"operationId":"secrets.environments.diff","summary":"Compare two environments by name: present where, and equal or not","description":"`secrets:ListSecrets` Compare two environments by name: present where, and equal or not. `from` and `to` are environment ids or `default` (the value every environment falls back to). Equality is computed server-side and needs secrets:CompareSecretValues on both secrets (audited); otherwise the row is `unknown` with the reason. Values are never returned.","tags":["Secrets"],"parameters":[{"name":"from","in":"query","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":"default"},{"type":"string","const":"shared"}],"description":"One side of the comparison: an environment id, or `default` for the Default values (`shared`, its old name, is accepted). An unknown environment id is 404."}},{"name":"to","in":"query","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":"default"},{"type":"string","const":"shared"}],"description":"The other side: an environment id, or `default` (`shared` is accepted). An unknown environment id is 404."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecrets","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CompareSecretValues"]}},"/secrets/api/environments/matrix":{"get":{"operationId":"secrets.environments.matrix","summary":"Every secret name × Default and each environment: what each environment resolves it to","description":"`secrets:ListSecrets` Every secret name × Default and each environment: what each environment resolves it to. `resolves[envId].resolution` is own, default (no own secret: the Default value) or missing; `promotableFrom` names an earlier environment that has it. `compare=1` adds a `valueClass` letter per cell (same letter, same value), audited per secret. Values are never returned.","tags":["Secrets"],"parameters":[{"name":"compare","in":"query","required":false,"schema":{"description":"1: add a `valueClass` letter to each cell (the same letter, the same value), compared on the server; needs secrets:CompareSecretValues on each secret, each compare audited, refused ones counted in `notCompared`. Omitted or 0: no comparison.","type":"string","enum":["0","1"]}},{"name":"group","in":"query","required":false,"schema":{"description":"Only names filed in this group or a group below it, e.g. dialog or dialog/auth; up to 122 characters. Omitted: every group, Ungrouped included.","type":"string","maxLength":122}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecrets","x-ews-mutates":false,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CompareSecretValues"]}},"/secrets/api/environments/promote":{"post":{"operationId":"secrets.environments.promote-many","summary":"Promote many secrets into one environment; `dryRun` returns the plan first","description":"`secrets:PromoteSecret` Promote many secrets into one environment; `dryRun` returns the plan first. Each item gets a `plan`: create, update, unchanged, not-compared (no secrets:CompareSecretValues), needs-reference (synced: confirm `suggestedReference` and send it as the item’s `reference`) or blocked (`error`). Run the dry run, then the same items without `dryRun`. Per item, not atomic.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"toEnvironmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The environment every item is promoted into, or null for Default. An item already in it is blocked; an unknown id blocks every item with 404."},"items":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"secretId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The secret to promote (its id in the environment it comes from)"},"reference":{"description":"Synced secrets only: the reference the target syncs from, normally the item’s `suggestedReference` from the dry run. Up to 512 characters.","type":"string","minLength":1,"maxLength":512}},"required":["secretId"]},"description":"The secrets to promote, 1 to 500, each { secretId, reference? }. Promoted one at a time in this order; each is authorized and answered on its own."},"dryRun":{"description":"true: answer with each item’s plan and write nothing (only value comparisons are made, each audited). Omitted or false: promote.","type":"boolean"}},"required":["toEnvironmentId","items"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:PromoteSecret","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CreateSecret","secrets:RotateSecret","secrets:UseSecretSource","secrets:CompareSecretValues"]}},"/secrets/api/groups":{"get":{"operationId":"secrets.groups.list","summary":"The group tree with how many secrets each group holds","description":"`secrets:ListSecrets` The group tree with how many secrets each group holds. Counts include every group below. A group exists while a secret is filed in it; move secrets with `secrets update --group` or `secrets bulk-move`.","tags":["Secrets"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecrets","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/secrets":{"get":{"operationId":"secrets.secrets.list","summary":"List secrets without their values","description":"`secrets:ListSecrets` List secrets without their values.","tags":["Secrets"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecrets","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"secrets.secrets.create","summary":"Create a secret encrypted under a CMK — from a value, or synced from a source reference","description":"`secrets:CreateSecret` Create a secret encrypted under a CMK — from a value, or synced from a source reference. Give `value`, or `reference: { ref: \"op://vault/item/field\", source? }` for a synced secret. Without `source` (a source name) the source whose token reaches the vault is used; several such sources is a refusal naming them. Needs secrets:UseSecretSource on the source; the reference must resolve now.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Z][A-Z0-9_]*$","description":"The name apps and workflows look it up by: UPPER_SNAKE_CASE starting with a letter, 1 to 128 characters. Unique per environment (and once as the Default): a taken name is 409."},"description":{"description":"Free-text description, up to 256 characters","type":"string","maxLength":256},"environmentId":{"description":"The environment it overrides the Default value in (an environment id). Omitted or null: the Default value every environment falls back to. An unknown id is 404.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"keyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The KMS key (CMK) to encrypt it under. Required in the API; the console pre-selects the organization’s default key. Unknown: 404; not enabled: 409; not an encrypt_decrypt key: 400."},"value":{"description":"The plaintext value, at least 1 character; stored as version 1. Give exactly one of `value` and `reference` (both or neither is 400).","type":"string","minLength":1},"reference":{"description":"Make it a synced secret: { ref, source?, sourceId? }. `ref` is op://vault/item/field or vault://mount/path#key, up to 512 characters; it must resolve now (else 422, or 502 when the source itself fails). Without `source` or `sourceId` the source whose credential reaches the vault is used; several such sources is 409 naming them. A reference another secret already syncs is 409. Needs secrets:UseSecretSource on the source.","type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":512,"description":"The reference, op://vault/item/field or vault://mount/path#key"},"source":{"description":"The source to sync through, by name","type":"string","minLength":2,"maxLength":63},"sourceId":{"description":"The source to sync through, by id","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ref"]},"scope":{"description":"A label for what the secret belongs to: organization, project or resource. Omitted: organization. It grants nothing.","type":"string","enum":["organization","project","resource"]},"scopeRef":{"description":"What `scope` names: a project slug or a resource RN, up to 500 characters. Omitted or null: none.","anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"rotationIntervalDays":{"description":"Days between rotations, 1 to 3650: sets a due date (`rotatesAt`); it does not generate values. Omitted or null: no rotation policy.","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"group":{"description":"Where to file it, e.g. dialog/auth: up to three segments of lower-case letters, digits and hyphens (up to 40 each), at most 122 characters. Null: Ungrouped. Omitted: Ungrouped, or for a synced secret its vault and item path. A name that already exists in another environment keeps that name’s group whatever is sent.","anyOf":[{"type":"string","maxLength":122},{"type":"null"}]},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name","keyId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:CreateSecret","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:UseSecretSource"]}},"/secrets/api/secrets/{id}":{"get":{"operationId":"secrets.secrets.get","summary":"Describe one secret without its value","description":"`secrets:GetSecret` Describe one secret without its value.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GetSecret","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"secrets.secrets.update","summary":"Change a secret’s description, group or rotation interval (never its value)","description":"`secrets:UpdateSecret` Change a secret’s description, group or rotation interval (never its value). A group belongs to the name: changing it moves every environment’s secret of this name, and needs secrets:UpdateSecret on each.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"Free-text description, up to 256 characters. Null clears it; omitted: unchanged.","anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"group":{"description":"Where the name is filed, e.g. dialog/auth: up to three lower-case segments of letters, digits and hyphens, at most 122 characters. Null: Ungrouped; omitted: unchanged. Moves the secret of this name in every environment and needs secrets:UpdateSecret on each, else 403 and nothing moves.","anyOf":[{"type":"string","maxLength":122},{"type":"null"}]},"rotationIntervalDays":{"description":"Days between rotations, 1 to 3650: sets the due date (`rotatesAt`) to that many days from now; nothing rotates by itself. Null removes the policy; omitted: unchanged.","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UpdateSecret","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"secrets.secrets.delete","summary":"Delete a secret","description":"`secrets:DeleteSecret` Delete a secret.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:DeleteSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/access":{"get":{"operationId":"secrets.secrets.access-log","summary":"Show who has actually read a secret value","description":"`secrets:GetSecretAccessLog` Show who has actually read a secret value.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GetSecretAccessLog","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/flow":{"get":{"operationId":"secrets.secrets.flow","summary":"Show where a secret comes from and every consumer it goes to, with last reads","description":"`secrets:GetSecret` Show where a secret comes from and every consumer it goes to, with last reads. Origin is the store or a source reference with its sync status. Each consumer (app env var, database/cache binding, registry login, workflow grant, source credential, database master password) carries the version it last read and `stale` when that is older than the active version. Last reads need secrets:GetSecretAccessLog; without it `reads` is \"hidden\".","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GetSecret","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/grants":{"get":{"operationId":"secrets.secrets.list-grants","summary":"List which consumers may read a secret","description":"`secrets:ListSecretGrants` List which consumers may read a secret.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecretGrants","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"secrets.secrets.grant","summary":"Grant a consumer access to a secret","description":"`secrets:GrantSecret` Grant a consumer access to a secret.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consumer":{"type":"string","enum":["actions","deploy","cli","code","compute","registry"],"description":"Which consumer may read the value, e.g. actions (CI runs), deploy (deployed apps) or registry (pull-through cache credentials)"},"repositoryId":{"description":"Limit an actions grant to one repository; omitted or null means every repository","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"ttlDays":{"description":"Days until the grant expires; omitted or null means it does not expire","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]}},"required":["consumer"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GrantSecret","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"secrets.secrets.revoke-grant","summary":"Revoke a consumer grant","description":"`secrets:RevokeSecretGrant` Revoke a consumer grant. A DELETE that carries a JSON body — the consumer is named in the body, not the path. An omitted repositoryId revokes the every-repository grant, not every scoped one.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consumer":{"type":"string","enum":["actions","deploy","cli","code","compute","registry"],"description":"Which consumer may read the value, e.g. actions (CI runs), deploy (deployed apps) or registry (pull-through cache credentials)"},"repositoryId":{"description":"Limit an actions grant to one repository; omitted or null means every repository","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["consumer"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:RevokeSecretGrant","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/promote":{"post":{"operationId":"secrets.environments.promote","summary":"Copy a secret into another environment (or its source reference, if synced)","description":"`secrets:PromoteSecret` Copy a secret into another environment (or its source reference, if synced). A stored secret: its active value becomes a new version of the same-named secret in the target (created under the same key if missing). A synced secret: give `reference`; without it the answer is 409 with `suggestedReference` (the vault swapped for the target environment). Grants are not copied.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"toEnvironmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The environment to promote into (an environment id), or null for Default, the value every environment falls back to. The secret’s own environment is refused with 400; an unknown id with 404."},"reference":{"description":"Synced secrets only: the source reference the target should sync from, e.g. op://Production/db/password, up to 512 characters. Omitted for a synced secret: 409 with `suggestedReference` (the reference with the vault swapped for the target environment) to confirm and send back. Ignored for a stored secret.","type":"string","minLength":1,"maxLength":512}},"required":["toEnvironmentId"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:PromoteSecret","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CreateSecret","secrets:RotateSecret","secrets:UseSecretSource"]}},"/secrets/api/secrets/{id}/rollback":{"post":{"operationId":"secrets.secrets.rollback","summary":"Promote a retired version back to current","description":"`secrets:RollbackSecret` Promote a retired version back to current.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The version number to make active again (see list-versions). The active one is retired. A version the secret does not have is 404."}},"required":["version"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:RollbackSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/rotate":{"post":{"operationId":"secrets.secrets.rotate","summary":"Store a new value as the current version","description":"`secrets:RotateSecret` Store a new value as the current version.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","minLength":1,"description":"The new plaintext value, at least 1 character. It becomes the next version; the current one is retired, not deleted."}},"required":["value"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:RotateSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/sync":{"post":{"operationId":"secrets.secrets.sync","summary":"Refresh a synced secret from its source now","description":"`secrets:SyncSecret` Refresh a synced secret from its source now.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:SyncSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/{id}/value":{"get":{"operationId":"secrets.secrets.get-value","summary":"Reveal the decrypted value of a secret","description":"`secrets:GetSecretValue` Reveal the decrypted value of a secret. Sensitive read — denials are recorded in the audit log.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GetSecretValue","x-ews-mutates":false,"x-ews-sensitive":true}},"/secrets/api/secrets/{id}/versions":{"get":{"operationId":"secrets.secrets.list-versions","summary":"List stored versions of a secret","description":"`secrets:ListSecretVersions` List stored versions of a secret.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecretVersions","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/secrets/bulk/delete":{"post":{"operationId":"secrets.secrets.bulk-delete","summary":"Delete many secrets and every version of them, answered per secret","description":"`secrets:DeleteSecret` Delete many secrets and every version of them, answered per secret. A source’s credential is refused (disconnect the source instead).","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Secret ids, 1 to 500. Each is answered on its own: an unknown id or a refused permission fails that item only."}},"required":["ids"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:DeleteSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/bulk/grant":{"post":{"operationId":"secrets.secrets.bulk-grant","summary":"Grant one consumer access to many secrets, answered per secret","description":"`secrets:GrantSecret` Grant one consumer access to many secrets, answered per secret.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consumer":{"type":"string","enum":["actions","deploy","cli","code","compute","registry"],"description":"Which consumer may read the value, e.g. actions (CI runs), deploy (deployed apps) or registry (pull-through cache credentials)"},"repositoryId":{"description":"Limit an actions grant to one repository; omitted or null means every repository","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"ttlDays":{"description":"Days until the grant expires; omitted or null means it does not expire","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Secret ids, 1 to 500. Each is answered on its own: an unknown id or a refused permission fails that item only."}},"required":["consumer","ids"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:GrantSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/bulk/move":{"post":{"operationId":"secrets.secrets.bulk-move","summary":"Move secrets to a group (null: Ungrouped), answered per secret","description":"`secrets:UpdateSecret` Move secrets to a group (null: Ungrouped), answered per secret. Each secret’s every environment row moves; a name with one refused row does not move. Not atomic: `results` says which moved.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Secret ids, 1 to 500. Each is answered on its own: an unknown id or a refused permission fails that item only."},"group":{"anyOf":[{"type":"string","maxLength":122},{"type":"null"}],"description":"The group to file the names under, e.g. dialog/auth (up to three lower-case segments, at most 122 characters), or null for Ungrouped. Required."}},"required":["ids","group"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UpdateSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/secrets/bulk/revoke":{"post":{"operationId":"secrets.secrets.bulk-revoke","summary":"Revoke one consumer’s grant on many secrets, answered per secret","description":"`secrets:RevokeSecretGrant` Revoke one consumer’s grant on many secrets, answered per secret.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consumer":{"type":"string","enum":["actions","deploy","cli","code","compute","registry"],"description":"Which consumer may read the value, e.g. actions (CI runs), deploy (deployed apps) or registry (pull-through cache credentials)"},"repositoryId":{"description":"Limit an actions grant to one repository; omitted or null means every repository","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Secret ids, 1 to 500. Each is answered on its own: an unknown id or a refused permission fails that item only."}},"required":["consumer","ids"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:RevokeSecretGrant","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/source-providers":{"get":{"operationId":"secrets.sources.providers","summary":"List the providers a source can be, and their reference syntax","description":"`secrets:ListSecretSources` List the providers a source can be, and their reference syntax.","tags":["Secrets"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecretSources","x-ews-mutates":false,"x-ews-sensitive":false}},"/secrets/api/sources":{"get":{"operationId":"secrets.sources.list","summary":"List connected sources with sync status (never the credential)","description":"`secrets:ListSecretSources` List connected sources with sync status (never the credential).","tags":["Secrets"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:ListSecretSources","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"secrets.sources.create","summary":"Connect a source — the credential is verified, then stored as a secret","description":"`secrets:CreateSecretSource` Connect a source — the credential is verified, then stored as a secret.","tags":["Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*$","description":"The source’s name, 2 to 63 lower-case letters, digits and hyphens, unique in the organization (409 if taken). Its credential is stored as the secret SOURCE_<NAME>_TOKEN, which must not exist yet (409)."},"description":{"description":"Free-text description, up to 256 characters","type":"string","maxLength":256},"provider":{"type":"string","enum":["onepassword","vault"],"description":"onepassword (a 1Password service account) or vault (HashiCorp Vault or OpenBao)"},"credential":{"type":"string","minLength":8,"maxLength":8192,"description":"The provider credential, 8 to 8192 characters: a 1Password service-account token (ops_…), a Vault token, or an AppRole secret ID. Verified with the provider before anything is stored (rejected: 422), then encrypted as a secret."},"config":{"description":"Provider settings, at most 16 keys, each value up to 512 characters. Vault/OpenBao: address (https, required), namespace, authMethod (token or approle), roleId and approleMount (AppRole). 1Password: none. Omitted: {}. Settings the provider does not accept are 400.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","maxLength":512}},"keyId":{"description":"The KMS key the credential is encrypted under. Omitted: the organization’s default key, else its first enabled encrypt/decrypt key (none: 409). A key that is unknown, disabled or not encrypt/decrypt is 409.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"refreshIntervalMinutes":{"description":"Minutes between scheduled syncs, 5 to 1440. Omitted: 60.","type":"integer","minimum":5,"maximum":1440}},"required":["name","provider","credential"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:CreateSecretSource","x-ews-mutates":true,"x-ews-sensitive":false,"x-ews-alternate-actions":["secrets:CreateSecret"]}},"/secrets/api/sources/{id}":{"patch":{"operationId":"secrets.sources.update","summary":"Rename the source, replace the credential or change the refresh interval","description":"`secrets:UpdateSecretSource` Rename the source, replace the credential or change the refresh interval.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"New name, 2 to 63 lower-case letters, digits and hyphens; its credential secret is renamed to SOURCE_<NAME>_TOKEN with it. A taken name (or credential secret name) is 409. Synced secrets follow the source by id.","type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]*$"},"description":{"description":"Free-text description, up to 256 characters. Null clears it; omitted: unchanged.","anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"credential":{"description":"A replacement credential, 8 to 8192 characters. Verified first (rejected: 422), then written as a new version of the credential secret. Omitted: unchanged.","type":"string","minLength":8,"maxLength":8192},"config":{"description":"Replaces the provider settings whole (the same keys as on create). Verified with the new or the stored credential first: 400 for invalid settings, 422 when the provider refuses them. Omitted: unchanged.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","maxLength":512}},"refreshIntervalMinutes":{"description":"Minutes between scheduled syncs, 5 to 1440. Omitted: unchanged.","type":"integer","minimum":5,"maximum":1440}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UpdateSecretSource","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"secrets.sources.delete","summary":"Disconnect a source (refused while secrets still sync from it)","description":"`secrets:DeleteSecretSource` Disconnect a source (refused while secrets still sync from it).","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:DeleteSecretSource","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/sources/{id}/check":{"post":{"operationId":"secrets.sources.check","summary":"Check which references resolve — ok/error per reference, never a value","description":"`secrets:UseSecretSource` Check which references resolve — ok/error per reference, never a value.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"references":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":512},"description":"References to try through this source, 1 to 1000, each up to 512 characters; trimmed and de-duplicated. Each is answered ok or with its error; no value is returned."}},"required":["references"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UseSecretSource","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/sources/{id}/sync":{"post":{"operationId":"secrets.sources.sync","summary":"Refresh every secret synced from this source now","description":"`secrets:SyncSecret` Refresh every secret synced from this source now.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:SyncSecret","x-ews-mutates":true,"x-ews-sensitive":false}},"/secrets/api/sources/{id}/test":{"post":{"operationId":"secrets.sources.test","summary":"Check the stored credential still works","description":"`secrets:UseSecretSource` Check the stored credential still works.","tags":["Secrets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Secret source id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"secrets:UseSecretSource","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/bulk":{"post":{"operationId":"tags.tags.bulk","summary":"Set one key=value on up to 500 resources","description":"`tags:TagResource` Set one key=value on up to 500 resources. tags:TagResource is checked on each resource’s RN; refused ones are listed in `refused`, the rest are tagged.","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"value":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"},"resources":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","description":"What kind of resource, e.g. ec2:instance"},"resourceId":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The resource’s own id as its service issues it (uuid, i-…, ewdb-…)"}},"required":["resourceType","resourceId"]}}},"required":["key","value","resources"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:TagResource","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/coverage":{"get":{"operationId":"tags.tags.coverage","summary":"Existing resources that lack a key, by service","description":"`tags:ListTags` Existing resources that lack a key, by service. Ask this before making a key required: a required key only stops creates, so resources that lack it keep working, and `bulk` sets a value on them.","tags":["Tags & saved views"],"parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListTags","x-ews-mutates":false,"x-ews-sensitive":false}},"/tags/api/keys":{"get":{"operationId":"tags.tags.keys","summary":"Tag keys in use, with how many resources carry each","description":"`tags:ListTags` Tag keys in use, with how many resources carry each.","tags":["Tags & saved views"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListTags","x-ews-mutates":false,"x-ews-sensitive":false}},"/tags/api/policy/keys":{"put":{"operationId":"tags.policy.set-key","summary":"Declare a tag key, and whether every new resource must carry it","description":"`tags:ManageTagPolicy` Declare a tag key, and whether every new resource must carry it.","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"description":{"type":"string","maxLength":200},"required":{"type":"boolean"},"backfillFrom":{"type":"string","enum":["actor","none"]}},"required":["key","required"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ManageTagPolicy","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"tags.policy.delete-key","summary":"Forget a declared tag key (tags already set stay)","description":"`tags:ManageTagPolicy` Forget a declared tag key (tags already set stay).","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ManageTagPolicy","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/projects":{"get":{"operationId":"tags.projects.list","summary":"List projects","description":"`tags:ListProjects` List projects.","tags":["Tags & saved views"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"tags.projects.create","summary":"Create a project from a tag query","description":"`tags:ManageProjects` Create a project from a tag query. query is a conjunction: every clause must match. E.g. [{\"key\":\"product\",\"values\":[\"deutschlandgpt\"]}].","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":500},"query":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["key","values"]}}},"required":["name","query"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ManageProjects","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/projects/{id}":{"patch":{"operationId":"tags.projects.update","summary":"Rename a project or change its query","description":"`tags:ManageProjects` Rename a project or change its query.","tags":["Tags & saved views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"query":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"values":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["key","values"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ManageProjects","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"tags.projects.delete","summary":"Delete a project (its resources and tags stay)","description":"`tags:ManageProjects` Delete a project (its resources and tags stay).","tags":["Tags & saved views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ManageProjects","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/projects/{id}/resources":{"get":{"operationId":"tags.projects.resources","summary":"The resources a project’s query selects","description":"`tags:ListProjects` The resources a project’s query selects.","tags":["Tags & saved views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/tags/api/resource":{"get":{"operationId":"tags.tags.list","summary":"The tags on one resource","description":"`tags:ListTags` The tags on one resource. resourceType is `service:type`, e.g. `deploy:app`, `rds:db`, `cache:cluster`.","tags":["Tags & saved views"],"parameters":[{"name":"resourceType","in":"query","required":true,"schema":{"type":"string","description":"What kind of resource, e.g. ec2:instance"}},{"name":"resourceId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The resource’s own id as its service issues it (uuid, i-…, ewdb-…)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListTags","x-ews-mutates":false,"x-ews-sensitive":false},"put":{"operationId":"tags.tags.set","summary":"Set one tag on a resource (adds it, or replaces its value)","description":"`tags:TagResource` Set one tag on a resource (adds it, or replaces its value). tags:TagResource is checked on the tagged resource’s RN (e.g. rn:ews:de1:<org>:ec2:instance/i-…), not on the tags service. Tagging an app, database or cache with a project’s key puts it in that project.","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","description":"What kind of resource, e.g. ec2:instance"},"resourceId":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The resource’s own id as its service issues it (uuid, i-…, ewdb-…)"},"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"value":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}},"required":["resourceType","resourceId","key","value"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:TagResource","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"tags.tags.remove","summary":"Remove one tag from a resource","description":"`tags:UntagResource` Remove one tag from a resource. tags:UntagResource is checked on the tagged resource’s RN.","tags":["Tags & saved views"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","description":"What kind of resource, e.g. ec2:instance"},"resourceId":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9._:-]+$","description":"The resource’s own id as its service issues it (uuid, i-…, ewdb-…)"},"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}},"required":["resourceType","resourceId","key"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:UntagResource","x-ews-mutates":true,"x-ews-sensitive":false}},"/tags/api/topology":{"get":{"operationId":"tags.topology.get","summary":"The networks with their apps, databases, caches and VPN gateway","description":"`tags:ListProjects` The networks with their apps, databases, caches and VPN gateway. Without `project`, the whole organization, cut to the services the caller can describe (no permission of its own). With `project` (a project slug), only the resources its tags select, plus what those apps use, marked inScope=false; that needs tags:ListProjects. Each app lists `uses` as `database:<id>` / `cache:<id>` keys of the data nodes in the same network.","tags":["Tags & saved views"],"parameters":[{"name":"project","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListProjects","x-ews-mutates":false,"x-ews-sensitive":false}},"/tags/api/values":{"get":{"operationId":"tags.tags.values","summary":"The values one key has across the organization","description":"`tags:ListTags` The values one key has across the organization.","tags":["Tags & saved views"],"parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"tags:ListTags","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/apps/{appId}/access":{"get":{"operationId":"vpn.apps.access","summary":"Show the gateway for an app’s VPC and the app’s databases, caches and machines as targets","description":"`vpn:DescribeClientVpnEndpoints` Show the gateway for an app’s VPC and the app’s databases, caches and machines as targets. Needs deploy:DescribeApp on the app too. Bound databases and caches come back preselected, the app’s own machines offered; `unreachable` lists what the app uses that a gateway in its VPC cannot reach. With no gateway yet, `gateway` says what creating one costs — create it with `dcloud vpn endpoints create --vpc-id <vpc.id>`. `dcloud vpn peers connect --app <appId>` does the rest in one step.","tags":["VPN"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/connections/{id}":{"get":{"operationId":"vpn.connections.get","summary":"Describe a connection: tunnel state, BGP, learned prefixes, traffic, last log lines","description":"`vpn:DescribeVpnConnections` Describe a connection: tunnel state, BGP, learned prefixes, traffic, last log lines.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvcn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeVpnConnections","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"vpn.connections.modify","summary":"Change a connection; the gateway restarts the tunnel on its next sync","description":"`vpn:ModifyVpnConnection` Change a connection; the gateway restarts the tunnel on its next sync.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvcn-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"remoteAddress":{"description":"Public IPv4 of the remote device. WireGuard: optional, then only the remote dials","type":["string","null"]},"remoteId":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9.@_-]{0,127}$"},{"type":"null"}],"description":"IPsec: the remote’s IKE identity when it is not its address (behind NAT)"},"staticRoutes":{"maxItems":50,"type":"array","items":{"type":"string"},"description":"Static routing: the remote networks"},"remoteAsn":{"anyOf":[{"type":"integer","minimum":1,"maximum":4294967294},{"type":"null"}],"description":"BGP: the remote’s ASN"},"nat":{"type":"boolean","description":"Source-NAT traffic from the tunnel to the gateway’s VPC address"},"trafficSelectors":{"type":"string","enum":["route","policy"],"description":"IPsec: route-based (0.0.0.0/0) or policy-based (VPC ↔ remote networks)"},"psk":{"type":"string","pattern":"^[A-Za-z1-9._][A-Za-z0-9._]{7,63}$","description":"IPsec pre-shared key; generated when omitted"},"remotePublicKey":{"type":"string","description":"WireGuard: the remote’s public key"},"remotePort":{"anyOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null"}],"description":"WireGuard: the remote’s port"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:ModifyVpnConnection","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"vpn.connections.delete","summary":"Delete a connection; the tunnel closes and its VPC routes go","description":"`vpn:DeleteVpnConnection` Delete a connection; the tunnel closes and its VPC routes go.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvcn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DeleteVpnConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/connections/{id}/device-config":{"get":{"operationId":"vpn.connections.device-config","summary":"The configuration for the remote device (includes the pre-shared key)","description":"`vpn:GetVpnConnectionDeviceConfiguration` The configuration for the remote device (includes the pre-shared key). A sensitive read, audited. Formats: generic (parameter sheet), strongswan, wireguard, unifi, pfsense, opnsense, fortinet (FortiOS CLI), aws-vgw (Terraform for the AWS side), ews (the matching connection for another Deutsche Cloud VPC).","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvcn-[0-9a-f]{12}$"}},{"name":"format","in":"query","required":false,"schema":{"default":"generic","type":"string","enum":["generic","strongswan","wireguard","unifi","pfsense","opnsense","fortinet","aws-vgw","ews"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:GetVpnConnectionDeviceConfiguration","x-ews-mutates":false,"x-ews-sensitive":true}},"/vpn/api/endpoints":{"get":{"operationId":"vpn.endpoints.list","summary":"List VPN gateways","description":"`vpn:DescribeClientVpnEndpoints` List VPN gateways.","tags":["VPN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"vpn.endpoints.create","summary":"Create a VPN gateway in a VPC (a billed machine)","description":"`vpn:CreateClientVpnEndpoint` Create a VPN gateway in a VPC (a billed machine). Omit vpcId for the default VPC, where apps and databases run. One gateway per VPC. The response carries the price; the gateway becomes available once its machine reports its WireGuard key, usually within two minutes.","tags":["VPN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"nodeType":{"description":"An instance type from node-types, e.g. performance-2. The provider’s own type names are still accepted, deprecated.","type":"string","minLength":1,"maxLength":32},"highlyAvailable":{"default":false,"description":"Two gateways on different hosts behind one floating IP, with automatic failover","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:CreateClientVpnEndpoint","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/endpoints/{id}":{"get":{"operationId":"vpn.endpoints.get","summary":"Describe a VPN gateway","description":"`vpn:DescribeClientVpnEndpoints` Describe a VPN gateway.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false},"delete":{"operationId":"vpn.endpoints.delete","summary":"Delete a VPN gateway; every peer on it stops working","description":"`vpn:DeleteClientVpnEndpoint` Delete a VPN gateway; every peer on it stops working.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DeleteClientVpnEndpoint","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/endpoints/{id}/events":{"get":{"operationId":"vpn.endpoints.events","summary":"Read a gateway’s activity: provisioning, peer changes, connections","description":"`vpn:DescribeClientVpnEndpoints` Read a gateway’s activity: provisioning, peer changes, connections.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/endpoints/{id}/peers":{"get":{"operationId":"vpn.peers.list","summary":"List a gateway’s peers with their last handshake and traffic","description":"`vpn:DescribeClientVpnConnections` List a gateway’s peers with their last handshake and traffic.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnConnections","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"vpn.peers.create","summary":"Create a peer from a public key and the resources it may reach","description":"`vpn:CreateClientVpnPeer` Create a peer from a public key and the resources it may reach. Generate the key pair locally (`wg genkey | tee key | wg pubkey`) and send only the public key — or use `dcloud vpn peers connect`, which does it for you and writes the .conf. Each target is written type:id (vpc, database, cache, app, instance) and is authorized as vpn:CreateClientVpnPeer on THAT resource’s RN as well as on the gateway. Returns the .conf with a placeholder where the private key goes. Expires after 30 days unless expiresInDays says otherwise.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-z0-9][a-z0-9-]*$"},"publicKey":{"type":"string"},"targets":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["vpc","database","cache","app","instance"]},"id":{"type":"string","minLength":1,"maxLength":64}},"required":["type","id"]}},"expiresInDays":{"default":30,"type":"integer","minimum":1,"maximum":365}},"required":["name","publicKey","targets"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:CreateClientVpnPeer","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/endpoints/{id}/targets":{"get":{"operationId":"vpn.endpoints.targets","summary":"List what a peer on this gateway could be granted, with addresses","description":"`vpn:DescribeClientVpnEndpoints` List what a peer on this gateway could be granted, with addresses. The VPC itself and every database, cache, app and instance in it that has a private address. A database with a private name lists it as hostname — connect to that name.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvpn-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/gateways":{"get":{"operationId":"vpn.gateways.list","summary":"List site-to-site gateways","description":"`vpn:DescribeVpnGateways` List site-to-site gateways.","tags":["VPN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeVpnGateways","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"vpn.gateways.create","summary":"Create a site-to-site gateway in a VPC (two billed machines)","description":"`vpn:CreateVpnGateway` Create a site-to-site gateway in a VPC (two billed machines). Omit vpcId for the default VPC. Always two machines (de1a and de1b when in stock), active and standby behind one public IP; the standby takes over after 30 s of silence. Available in about two minutes; then add connections. The response carries the price of both machines. `asn` is Deutsche Cloud’s side of every BGP session (default 64600).","tags":["VPN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"description":"Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting \"allow EU outside Germany\".","type":"string","minLength":1,"maxLength":32},"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-z0-9][a-z0-9-]*$"},"vpcId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"nodeType":{"description":"Each machine’s instance type, e.g. performance-2; omitted: a small default. The provider’s own type names are still accepted, deprecated.","type":"string","minLength":1,"maxLength":32},"asn":{"default":64600,"description":"Deutsche Cloud’s side of every BGP session","type":"integer","minimum":1,"maximum":4294967294},"allowTransit":{"default":false,"description":"Let two connections of this gateway reach each other (hub and spoke)","type":"boolean"},"tags":{"description":"Tags for the new resource, e.g. {\"env\": \"prod\", \"project\": \"shop\"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).","type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z][a-z0-9_.-]*$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:@/-]*$"}}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:CreateVpnGateway","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/gateways/{id}":{"get":{"operationId":"vpn.gateways.get","summary":"Describe a gateway with its connections and the routes the VPC carries","description":"`vpn:DescribeVpnGateways` Describe a gateway with its connections and the routes the VPC carries. `machineRouteCommand` is the one line a machine that existed before the gateway runs to reach the tunnels; instances launched since carry it.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeVpnGateways","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"vpn.gateways.modify","summary":"Rename a gateway or let its connections reach each other (allowTransit)","description":"`vpn:ModifyVpnGateway` Rename a gateway or let its connections reach each other (allowTransit).","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-z0-9][a-z0-9-]*$"},"allowTransit":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:ModifyVpnGateway","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"vpn.gateways.delete","summary":"Delete a gateway; every tunnel closes and its VPC routes go","description":"`vpn:DeleteVpnGateway` Delete a gateway; every tunnel closes and its VPC routes go.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DeleteVpnGateway","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/gateways/{id}/connections":{"get":{"operationId":"vpn.connections.list","summary":"List a gateway’s connections with their state, BGP and traffic","description":"`vpn:DescribeVpnConnections` List a gateway’s connections with their state, BGP and traffic.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeVpnConnections","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"vpn.connections.create","summary":"Create a tunnel to an office, another cloud or another Deutsche Cloud VPC","description":"`vpn:CreateVpnConnection` Create a tunnel to an office, another cloud or another Deutsche Cloud VPC. IPsec needs remoteAddress; the pre-shared key is generated unless given (read it with device-config). WireGuard needs remotePublicKey; the gateway’s own key is wireguardPublicKey on the gateway. Static routing names the remote networks; BGP names the remote ASN and the remote announces its networks. Download the remote device’s configuration with `dcloud vpn connections device-config --id <id> --format unifi|pfsense|opnsense|fortinet|aws-vgw|strongswan|wireguard|ews|generic`.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-z0-9][a-z0-9-]*$"},"type":{"type":"string","enum":["ipsec","wireguard"]},"routing":{"default":"static","type":"string","enum":["static","bgp"]},"remoteAddress":{"default":null,"description":"Public IPv4 of the remote device. WireGuard: optional, then only the remote dials","type":["string","null"]},"remoteId":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9.@_-]{0,127}$"},{"type":"null"}],"description":"IPsec: the remote’s IKE identity when it is not its address (behind NAT)"},"staticRoutes":{"default":[],"maxItems":50,"type":"array","items":{"type":"string"},"description":"Static routing: the remote networks"},"remoteAsn":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":4294967294},{"type":"null"}],"description":"BGP: the remote’s ASN"},"insideCidr":{"description":"Inside-tunnel /30; allocated when omitted","type":"string"},"insideLocalIsFirst":{"default":false,"description":"Deutsche Cloud takes the first host of the /30 (the far side of an EWS-to-EWS pair)","type":"boolean"},"nat":{"default":false,"type":"boolean","description":"Source-NAT traffic from the tunnel to the gateway’s VPC address"},"trafficSelectors":{"default":"route","type":"string","enum":["route","policy"],"description":"IPsec: route-based (0.0.0.0/0) or policy-based (VPC ↔ remote networks)"},"psk":{"type":"string","pattern":"^[A-Za-z1-9._][A-Za-z0-9._]{7,63}$","description":"IPsec pre-shared key; generated when omitted"},"remotePublicKey":{"type":"string","description":"WireGuard: the remote’s public key"},"remotePort":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null"}],"description":"WireGuard: the remote’s port"}},"required":["name","type"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:CreateVpnConnection","x-ews-mutates":true,"x-ews-sensitive":false}},"/vpn/api/gateways/{id}/events":{"get":{"operationId":"vpn.gateways.events","summary":"Read a gateway’s activity: provisioning, tunnels up and down, BGP, failovers, routes","description":"`vpn:DescribeVpnGateways` Read a gateway’s activity: provisioning, tunnels up and down, BGP, failovers, routes.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewvgw-[0-9a-f]{12}$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeVpnGateways","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/node-types":{"get":{"operationId":"vpn.endpoints.node-types","summary":"List the machine sizes a gateway can run on, with their price","description":"`vpn:DescribeClientVpnEndpoints` List the machine sizes a gateway can run on, with their price. The entry with isDefault is what a gateway runs on when no nodeType is given.","tags":["VPN"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnEndpoints","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/peers/{id}":{"get":{"operationId":"vpn.peers.get","summary":"Describe a peer, with its .conf (private key left out — Deutsche Cloud never had it)","description":"`vpn:DescribeClientVpnConnections` Describe a peer, with its .conf (private key left out — Deutsche Cloud never had it).","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewpeer-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:DescribeClientVpnConnections","x-ews-mutates":false,"x-ews-sensitive":false}},"/vpn/api/peers/{id}/revoke":{"post":{"operationId":"vpn.peers.revoke","summary":"Revoke a peer; the gateway drops it on its next sync, within about 20 seconds","description":"`vpn:RevokeClientVpnPeer` Revoke a peer; the gateway drops it on its next sync, within about 20 seconds. The peer stays listed as revoked, so who could reach what stays readable.","tags":["VPN"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^ewpeer-[0-9a-f]{12}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"vpn:RevokeClientVpnPeer","x-ews-mutates":true,"x-ews-sensitive":false}},"/waf/api/managed-rule-groups":{"get":{"operationId":"waf.managed-rule-groups.list","summary":"List the managed rule groups and their rule ids (for exclude)","description":"`waf:ListWebAcls` List the managed rule groups and their rule ids (for exclude).","tags":["Web application firewall"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:ListWebAcls","x-ews-mutates":false,"x-ews-sensitive":false}},"/waf/api/web-acls":{"get":{"operationId":"waf.web-acls.list","summary":"List web ACLs and the distributions and load balancers using each","description":"`waf:ListWebAcls` List web ACLs and the distributions and load balancers using each.","tags":["Web application firewall"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:ListWebAcls","x-ews-mutates":false,"x-ews-sensitive":false},"post":{"operationId":"waf.web-acls.create","summary":"Create a web ACL (without rules: the Deutsche Cloud Core defaults)","description":"`waf:CreateWebAcl` Create a web ACL (without rules: the Deutsche Cloud Core defaults). Rules run in order; the first allow, block or unpassed challenge decides, count matches are logged and evaluation goes on. Statements: ipSet {cidrs}, geo {countries, ISO alpha-2, XX = unknown}, match {field path|query|uri|method|header|body, header, op exact|prefix|contains|regex, value, negate}, rate {key ip|ipPath, pathPrefix, limit, windowSeconds; counted across all edge nodes, synced every second; 429}, managed {group sqli|xss|traversal|rce|php-java|scanners|protocol, exclude}. challenge: a JavaScript proof of work for browsers, 403 {\"error\":\"challenge_required\"} for anything else.","tags":["Web application firewall"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]*$"},"description":{"type":"string","maxLength":256},"defaultAction":{"type":"string","enum":["allow","block"]},"rules":{"description":"In order. Omitted: the Deutsche Cloud Core defaults (injection groups block, scanners and protocol count)","maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$"},"name":{"type":"string","maxLength":128},"action":{"type":"string","enum":["allow","block","count","challenge"]},"statement":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"ipSet"},"cidrs":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string"}}},"required":["type","cidrs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"geo"},"countries":{"minItems":1,"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["type","countries"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"match"},"field":{"type":"string","enum":["path","query","uri","method","header","body"]},"header":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,64}$"},"op":{"type":"string","enum":["exact","prefix","contains","regex"]},"value":{"type":"string","maxLength":512},"negate":{"type":"boolean"}},"required":["type","field","op","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"rate"},"key":{"type":"string","enum":["ip","ipPath"]},"pathPrefix":{"type":"string","maxLength":256,"format":"starts_with","pattern":"^\\/.*"},"limit":{"type":"integer","minimum":1,"maximum":1000000},"windowSeconds":{"type":"integer","minimum":1,"maximum":3600}},"required":["type","key","limit","windowSeconds"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"managed"},"group":{"type":"string","enum":["sqli","xss","traversal","rce","php-java","scanners","protocol"]},"exclude":{"maxItems":64,"type":"array","items":{"type":"string","maxLength":32}}},"required":["type","group"],"additionalProperties":false}]}},"required":["id","action","statement"],"additionalProperties":false}},"bodyInspectBytes":{"type":"integer","minimum":0,"maximum":65536}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:CreateWebAcl","x-ews-mutates":true,"x-ews-sensitive":false}},"/waf/api/web-acls/{id}":{"get":{"operationId":"waf.web-acls.get","summary":"Describe a web ACL","description":"`waf:GetWebAcl` Describe a web ACL. distributions and loadBalancers: where it is attached (load balancers you may describe). enforcement: how many edge and load balancer nodes run it, and any rule a node on an older build cannot enforce yet (for about two minutes after an update; degraded = a block or challenge rule left out).","tags":["Web application firewall"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:GetWebAcl","x-ews-mutates":false,"x-ews-sensitive":false},"patch":{"operationId":"waf.web-acls.update","summary":"Change a web ACL; every distribution and load balancer using it gets the rules within seconds","description":"`waf:UpdateWebAcl` Change a web ACL; every distribution and load balancer using it gets the rules within seconds.","tags":["Web application firewall"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","maxLength":256},"defaultAction":{"type":"string","enum":["allow","block"]},"rules":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$"},"name":{"type":"string","maxLength":128},"action":{"type":"string","enum":["allow","block","count","challenge"]},"statement":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"ipSet"},"cidrs":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string"}}},"required":["type","cidrs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"geo"},"countries":{"minItems":1,"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["type","countries"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"match"},"field":{"type":"string","enum":["path","query","uri","method","header","body"]},"header":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,64}$"},"op":{"type":"string","enum":["exact","prefix","contains","regex"]},"value":{"type":"string","maxLength":512},"negate":{"type":"boolean"}},"required":["type","field","op","value"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"rate"},"key":{"type":"string","enum":["ip","ipPath"]},"pathPrefix":{"type":"string","maxLength":256,"format":"starts_with","pattern":"^\\/.*"},"limit":{"type":"integer","minimum":1,"maximum":1000000},"windowSeconds":{"type":"integer","minimum":1,"maximum":3600}},"required":["type","key","limit","windowSeconds"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"managed"},"group":{"type":"string","enum":["sqli","xss","traversal","rce","php-java","scanners","protocol"]},"exclude":{"maxItems":64,"type":"array","items":{"type":"string","maxLength":32}}},"required":["type","group"],"additionalProperties":false}]}},"required":["id","action","statement"],"additionalProperties":false}},"bodyInspectBytes":{"type":"integer","minimum":0,"maximum":65536}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:UpdateWebAcl","x-ews-mutates":true,"x-ews-sensitive":false},"delete":{"operationId":"waf.web-acls.delete","summary":"Delete a web ACL no distribution or load balancer uses","description":"`waf:DeleteWebAcl` Delete a web ACL no distribution or load balancer uses.","tags":["Web application firewall"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:DeleteWebAcl","x-ews-mutates":true,"x-ews-sensitive":false}},"/waf/api/web-acls/{id}/logs":{"get":{"operationId":"waf.web-acls.logs","summary":"The requests the web ACL matched: action, rule, field, value, client, path, node","description":"`waf:GetWafLogs` The requests the web ACL matched: action, rule, field, value, client, path, node. Kept 7 days; stored at about 50 lines/s per distribution or load balancer, blocks first. distributionId or loadBalancerId narrows it to one.","tags":["Web application firewall"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}},{"name":"distributionId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"loadBalancerId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Input failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, malformed or expired access key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The caller’s IAM policies do not allow this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such resource in the caller’s organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ews-action":"waf:GetWafLogs","x-ews-mutates":false,"x-ews-sensitive":false}}}}