{ "components": { "schemas": { "CloneZonePayload": { "description": "metadata to clone a zone.", "properties": { "adjustRecords": { "description": "Adjust record set content and replace the dns name of the original zone with the new dns name of the cloned zone", "example": true, "type": "boolean" }, "description": { "description": "New Description for the cloned zone. Leave empty to use the same description as the original zone", "example": "this is our example zone", "maxLength": 1024, "type": "string" }, "dnsName": { "description": "DnsName is the dns name of the zone to clone", "example": "example.com", "maxLength": 253, "minLength": 1, "type": "string" }, "name": { "description": "New Name for the cloned zone. Leave empty to use the same name as the original zone", "example": "test", "maxLength": 63, "minLength": 1, "type": "string" } }, "required": [ "dnsName" ], "type": "object" }, "CreateLabelPayload": { "properties": { "key": { "example": "kubernetes.io/cluster", "maxLength": 314, "minLength": 1, "type": "string" }, "value": { "example": "foobar", "maxLength": 63, "type": "string" } }, "required": [ "key" ], "type": "object" }, "CreateLabelResponse": { "description": "ResponseUpsertLabel.", "properties": { "label": { "$ref": "#/components/schemas/Label" }, "message": { "example": "Success", "type": "string" } }, "type": "object" }, "CreateMoveCodePayload": { "description": "options for generating a move code.", "properties": { "ttl": { "description": "TTL is the duration for which the move code is valid, represented as seconds. Min: 1, Max: 2592000 (30 days).", "example": 86400, "format": "int32", "maximum": 2592000, "minimum": 1, "type": "integer" } }, "type": "object" }, "CreateRecordSetPayload": { "description": "RRSetPost for rr set info.", "properties": { "comment": { "description": "user comment", "example": "this is our example comment", "maxLength": 255, "type": "string" }, "name": { "description": "name of the record which should be a valid domain according to rfc1035 Section 2.3.4. For APEX records (same as zone name), the zone name itself has to be put in here.", "example": "example.com.", "maxLength": 253, "minLength": 1, "type": "string" }, "records": { "description": "records", "items": { "$ref": "#/components/schemas/RecordPayload" }, "type": "array" }, "ttl": { "description": "time to live. If nothing provided we will set the zone ttl.", "example": 3600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "type": { "description": "record set type", "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "ALIAS", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "TYPE", "CSYNC", "HINFO", "HTTPS" ], "example": "A", "type": "string" } }, "required": [ "name", "records", "type" ], "type": "object" }, "CreateZonePayload": { "description": "Zone to create.", "properties": { "acl": { "default": "0.0.0.0/0,::/0", "description": "the access control list (note: this field currently has no effect and does not enforce any access restrictions on the DNS zone)", "example": "0.0.0.0/0,::/0", "maxLength": 2000, "type": "string" }, "contactEmail": { "default": "hostmaster@stackit.cloud", "description": "contact e-mail for the zone", "example": "hostmaster@stackit.cloud", "maxLength": 255, "type": "string" }, "defaultTTL": { "default": 3600, "description": "default time to live", "example": 3600, "format": "int32", "minimum": 60, "type": "integer" }, "description": { "description": "description of the zone", "example": "this is our example zone", "maxLength": 1024, "type": "string" }, "dnsName": { "description": "zone name", "example": "example.com", "maxLength": 253, "minLength": 1, "type": "string" }, "expireTime": { "default": 1209600, "description": "expire time", "example": 1209600, "format": "int32", "minimum": 60, "type": "integer" }, "extensions": { "allOf": [ { "$ref": "#/components/schemas/zone.Extensions" } ], "description": "optional extensions", "type": "object" }, "isReverseZone": { "default": false, "description": "if the zone is a reverse zone or not", "example": false, "type": "boolean" }, "labelsMap": { "additionalProperties": { "type": "string" }, "description": "labels for the zone - max 64 items. Keys: 1-314 chars (up to 250 prefix, 1 for slash, 1-63 the actual key). Values: 0-63 chars.", "example": { "foo": "bar", "kubernetes.io/cluster": "foobar" }, "type": "object" }, "name": { "description": "user given name", "example": "test", "maxLength": 63, "minLength": 1, "type": "string" }, "negativeCache": { "description": "negative caching", "example": 60, "format": "int32", "minimum": 60, "type": "integer" }, "primaries": { "description": "primary name server for secondary zone", "example": [ "192.0.2.1" ], "items": { "type": "string" }, "type": "array" }, "refreshTime": { "default": 3600, "description": "refresh time", "example": 3600, "format": "int32", "minimum": 60, "type": "integer" }, "retryTime": { "default": 600, "description": "retry time", "example": 600, "format": "int32", "minimum": 60, "type": "integer" }, "type": { "default": "primary", "description": "zone type", "enum": [ "primary", "secondary" ], "example": "primary", "type": "string" } }, "required": [ "dnsName", "name" ], "type": "object" }, "DeleteLabelResponse": { "description": "ResponseDeleteLabel.", "properties": { "label": { "$ref": "#/components/schemas/Label" }, "message": { "example": "Success", "type": "string" } }, "type": "object" }, "ErrorMessage": { "properties": { "error": { "example": "Error", "type": "string" }, "message": { "example": "Error message", "type": "string" } }, "type": "object" }, "ExportRecordSetsPayload": { "properties": { "exportAsFQDN": { "default": true, "example": true, "type": "boolean" }, "format": { "default": "csv", "enum": [ "csv", "json", "bind" ], "example": "csv", "type": "string" } }, "type": "object" }, "FlushDomainPayload": { "properties": { "domain": { "example": "example.com", "type": "string" }, "type": { "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "CSYNC", "HINFO", "HTTPS" ], "example": "A", "type": "string" } }, "required": [ "domain" ], "type": "object" }, "FlushDomainResponse": { "properties": { "message": { "example": "Success", "type": "string" } }, "type": "object" }, "ImportRecordSetsPayload": { "properties": { "rrSets": { "items": { "$ref": "#/components/schemas/zone_models.ImportRecordModel" }, "type": "array" } }, "type": "object" }, "ImportRecordSetsResponse": { "description": "ImportSummaryResponse is the response of the import.", "properties": { "message": { "example": "Success", "type": "string" }, "summary": { "$ref": "#/components/schemas/ImportSummary" } }, "required": [ "summary" ], "type": "object" }, "ImportSummary": { "description": "ImportSummary is the summary of the import.", "properties": { "createdRRSets": { "example": 0, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "createdRecords": { "example": 0, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "deletedRRSets": { "example": 10000, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "deletedRecords": { "example": 10000, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "updatedRRSets": { "example": 5, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "updatedRecords": { "example": 5, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" } }, "type": "object" }, "Label": { "properties": { "key": { "example": "kubernetes.io/cluster", "maxLength": 314, "minLength": 1, "type": "string" }, "value": { "example": "foobar", "maxLength": 63, "type": "string" } }, "required": [ "key" ], "type": "object" }, "ListLabelsResponse": { "description": "ResponseAllLabels.", "properties": { "labels": { "items": { "$ref": "#/components/schemas/Label" }, "type": "array" }, "message": { "example": "Success", "type": "string" } }, "type": "object" }, "ListRecordSetsResponse": { "description": "ResponseRRSetAll.", "properties": { "itemsPerPage": { "example": 1, "format": "int32", "type": "integer" }, "message": { "example": "Success", "type": "string" }, "rrSets": { "items": { "$ref": "#/components/schemas/RecordSet" }, "type": "array" }, "totalItems": { "example": 1, "format": "int32", "type": "integer" }, "totalPages": { "example": 1, "format": "int32", "type": "integer" } }, "required": [ "itemsPerPage", "rrSets", "totalItems", "totalPages" ], "type": "object" }, "ListZonesResponse": { "description": "ResponseZoneAll for filtered zones.", "properties": { "itemsPerPage": { "example": 1, "format": "int32", "type": "integer" }, "message": { "example": "Success", "type": "string" }, "totalItems": { "example": 1, "format": "int32", "type": "integer" }, "totalPages": { "example": 1, "format": "int32", "type": "integer" }, "zones": { "items": { "$ref": "#/components/schemas/Zone" }, "type": "array" } }, "required": [ "itemsPerPage", "totalItems", "totalPages", "zones" ], "type": "object" }, "LookupDomainPayload": { "properties": { "address": { "description": "Address is the domain name to look up", "example": "stackit.cloud", "type": "string" }, "includeRawResponse": { "default": false, "description": "IncludeRawResponse indicates whether to include the raw DNS response in the result", "example": false, "type": "boolean" }, "recordType": { "default": "A", "description": "RecordType specifies the DNS record type to query (A, AAAA, MX, etc.)\nIf omitted, defaults to ANY records", "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "ALIAS", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "TYPE", "CSYNC", "HINFO", "HTTPS", "ANY" ], "example": "A", "type": "string" }, "region": { "description": "Region optionally specifies a STACKIT region to scope the DNS lookup", "example": "eu01", "type": "string" }, "type": { "default": "one", "description": "Type specifies whether to query all configured resolvers or just one\n\"one\" - query a single resolver chosen by round-robin (default)\n\"all\" - query all configured resolvers", "enum": [ "all", "one" ], "example": "one", "type": "string" } }, "type": "object" }, "LookupDomainResponse": { "properties": { "message": { "example": "Success", "type": "string" }, "state": { "items": { "$ref": "#/components/schemas/LookupResult" }, "type": "array" } }, "type": "object" }, "LookupRecord": { "properties": { "data": { "description": "Data contains the record-specific data (e.g., IP address for A records)", "example": "192.0.2.1", "type": "string" }, "name": { "description": "Name is the domain name to which this record applies", "example": "example.com", "type": "string" }, "ttl": { "description": "TTL (Time To Live) is the duration in seconds that the record may be cached", "example": 3600, "type": "integer" }, "type": { "description": "Type is the DNS record type (A, AAAA, MX, etc.)", "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "ALIAS", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "TYPE", "CSYNC", "HINFO", "HTTPS" ], "example": "A", "type": "string" } }, "type": "object" }, "LookupResult": { "properties": { "rawResponse": { "description": "RawResponse contains the raw DNS response in a human-readable format (only included when requested)", "type": "string" }, "records": { "description": "Records contains the DNS records returned by the lookup", "items": { "$ref": "#/components/schemas/LookupRecord" }, "type": "array" }, "resolverIP": { "description": "ResolverIP is the IP address of the DNS resolver used for the query", "example": "192.0.2.1", "type": "string" } }, "type": "object" }, "Message": { "properties": { "message": { "example": "Success", "type": "string" } }, "type": "object" }, "MoveCodeResponse": { "properties": { "code": { "description": "code to move the zone. It is one time shown so better keep it.", "example": "3sLuLCLpLEbbQ6GZ05tu2U56dmKx1uCdWquTHz6BK34=", "type": "string" }, "expiresAt": { "description": "when the code expires", "example": "2023-08-08 08:58:25+00:00", "type": "string" }, "message": { "description": "human readable message", "example": "successfully created code to move the zone", "type": "string" } }, "required": [ "code", "expiresAt" ], "type": "object" }, "MoveZonePayload": { "description": "body to move zone from one project to another.", "properties": { "code": { "description": "Code to move the zone. It must be valid, not expired and belong", "example": "3sLuLCLpLEbbQ6GZ05tu2U56dmKx1uCdWquTHz6BK34=", "maxLength": 1024, "minLength": 1, "type": "string" }, "zoneDnsName": { "description": "ZoneDnsName is the dns name of the zone to move", "example": "example.com", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "code", "zoneDnsName" ], "type": "object" }, "PartialUpdateRecordPayload": { "description": "RecordPatch for record patch in record set.", "properties": { "action": { "enum": [ "add", "delete" ], "type": "string" }, "records": { "description": "records", "items": { "$ref": "#/components/schemas/RecordPayload" }, "type": "array" } }, "required": [ "action", "records" ], "type": "object" }, "PartialUpdateRecordSetPayload": { "description": "RRSetPatch for rr patch set info.", "properties": { "comment": { "description": "user comment", "example": "this is our example comment", "maxLength": 255, "type": "string" }, "name": { "description": "rfc1035 Section 2.3.4", "example": "example.com.", "maxLength": 253, "minLength": 1, "type": "string" }, "records": { "description": "records", "items": { "$ref": "#/components/schemas/RecordPayload" }, "type": "array" }, "ttl": { "description": "time to live", "example": 3600, "format": "int32", "maximum": 99999999, "minimum": 30, "type": "integer" } }, "type": "object" }, "PartialUpdateZonePayload": { "properties": { "acl": { "default": "0.0.0.0/0,::/0", "description": "the access control list (note: this field currently has no effect and does not enforce any access restrictions on the DNS zone)", "example": "0.0.0.0/0,::/0", "maxLength": 2000, "type": "string" }, "contactEmail": { "default": "hostmaster@stackit.cloud", "description": "contact e-mail for the zone", "example": "hostmaster@stackit.cloud", "maxLength": 255, "type": "string" }, "defaultTTL": { "default": 3600, "description": "default time to live", "example": 3600, "format": "int32", "minimum": 60, "type": "integer" }, "description": { "description": "description of the zone", "example": "this is our example zone", "maxLength": 1024, "type": "string" }, "expireTime": { "default": 1209600, "description": "expire time", "example": 1209600, "format": "int32", "minimum": 60, "type": "integer" }, "extensions": { "allOf": [ { "$ref": "#/components/schemas/domain.Extensions" } ], "description": "optional extensions", "type": "object" }, "labelsMap": { "additionalProperties": { "type": "string" }, "description": "labels for the zone - max 64 items. Keys: 1-314 chars (up to 250 prefix, 1 for slash, 1-63 the actual key). Values: 0-63 chars.", "example": { "foo": "bar", "kubernetes.io/cluster": "foobar" }, "type": "object" }, "name": { "description": "user given name", "example": "test", "maxLength": 63, "minLength": 1, "type": "string" }, "negativeCache": { "description": "negative caching", "example": 60, "format": "int32", "minimum": 60, "type": "integer" }, "primaries": { "description": "primary name server for secondary zone", "example": [ "1.2.3.4" ], "items": { "type": "string" }, "type": "array" }, "refreshTime": { "default": 3600, "description": "refresh time", "example": 3600, "format": "int32", "minimum": 60, "type": "integer" }, "retryTime": { "default": 600, "description": "retry time", "example": 600, "format": "int32", "minimum": 60, "type": "integer" } }, "type": "object" }, "Record": { "description": "Record.", "properties": { "content": { "description": "content of the record", "example": "192.0.2.1", "maxLength": 64000, "minLength": 1, "type": "string" }, "id": { "description": "rr set id", "example": "37403b63-86ce-41e9-9b0b-1d8c5b3b2b96", "minLength": 1, "type": "string" } }, "required": [ "content", "id" ], "type": "object" }, "RecordDataExchange": { "properties": { "comment": { "example": "comment", "type": "string" }, "content": { "example": [ "192.0.2.1" ], "items": { "type": "string" }, "type": "array" }, "name": { "example": "example.com", "type": "string" }, "ttl": { "example": 3600, "format": "int32", "type": "integer" }, "type": { "example": "A", "type": "string" } }, "type": "object" }, "RecordPayload": { "description": "RecordPost for rr set info.", "properties": { "content": { "description": "content of the record", "example": "192.0.2.1", "maxLength": 64000, "minLength": 1, "type": "string" } }, "required": [ "content" ], "type": "object" }, "RecordSet": { "description": "RRSet.", "properties": { "active": { "description": "if the record set is active or not", "example": true, "type": "boolean" }, "comment": { "description": "comment", "example": "This is a comment", "maxLength": 255, "type": "string" }, "creationFinished": { "description": "when record set creation finished", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "creationStarted": { "description": "when record set creation started", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "error": { "description": "Error shows error in case create/update/delete failed", "example": "error message", "maxLength": 2000, "type": "string" }, "id": { "description": "rr set id", "example": "37403b63-86ce-41e9-9b0b-1d8c5b3b2b96", "type": "string" }, "name": { "description": "name of the record which should be a valid domain according to rfc1035 Section 2.3.4. For APEX records (same as zone name), the zone name itself has to be put in here.", "example": "example.com.", "maxLength": 253, "minLength": 1, "type": "string" }, "records": { "description": "records", "items": { "$ref": "#/components/schemas/Record" }, "minItems": 1, "type": "array" }, "state": { "description": "record set state", "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "example": "CREATE_SUCCEEDED", "type": "string" }, "ttl": { "description": "time to live", "example": 3600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "type": { "description": "record set type", "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "ALIAS", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "TYPE", "CSYNC", "HINFO", "HTTPS" ], "example": "A", "type": "string" }, "updateFinished": { "description": "when record set update/deletion finished", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "updateStarted": { "description": "when record set update/deletion started", "example": "2022-01-31 10:00:00+00:00", "type": "string" } }, "required": [ "creationFinished", "creationStarted", "id", "name", "records", "state", "ttl", "type", "updateFinished", "updateStarted" ], "type": "object" }, "RecordSetResponse": { "description": "ResponseRRSet for rr set info.", "properties": { "message": { "example": "Success", "type": "string" }, "rrset": { "$ref": "#/components/schemas/RecordSet" } }, "required": [ "rrset" ], "type": "object" }, "ValidateMoveCodePayload": { "description": "PostValidateMoveCodeRequest body to validate move code request.", "properties": { "code": { "description": "code that should be validated. It validates if it is valid, not expired and belongs to the zone.", "example": "3sLuLCLpLEbbQ6GZ05tu2U56dmKx1uCdWquTHz6BK34=", "maxLength": 1024, "minLength": 1, "type": "string" } }, "required": [ "code" ], "type": "object" }, "Zone": { "description": "Zone.", "properties": { "acl": { "description": "access control list", "example": "0.0.0.0/0,::/0", "type": "string" }, "active": { "example": true, "type": "boolean" }, "contactEmail": { "description": "contact email from soa record", "example": "hostmaster.at.stackit.cloud.", "maxLength": 255, "type": "string" }, "creationFinished": { "description": "when zone creation finished", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "creationStarted": { "description": "when zone creation started", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "defaultTTL": { "description": "default time to live", "example": 3600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "description": { "description": "description of the zone", "example": "this is our example zone", "maxLength": 1024, "type": "string" }, "dnsName": { "description": "zone name", "example": "example.com", "maxLength": 253, "minLength": 1, "type": "string" }, "error": { "description": "Error shows error in case create/update/delete failed", "example": "error message", "maxLength": 2000, "type": "string" }, "expireTime": { "description": "expire time", "example": 1209600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "extensions": { "$ref": "#/components/schemas/domain.Extensions" }, "id": { "description": "zone id", "example": "37403b63-86ce-41e9-9b0b-1d8c5b3b2b96", "type": "string" }, "isReverseZone": { "description": "if the zone is a reverse zone or not", "example": false, "type": "boolean" }, "labels": { "items": { "$ref": "#/components/schemas/Label" }, "type": "array" }, "labelsMap": { "additionalProperties": { "type": "string" }, "description": "labels for the zone", "example": { "kubernetes.io/cluster": "foobar" }, "type": "object" }, "name": { "description": "user given name", "example": "test", "maxLength": 63, "minLength": 1, "type": "string" }, "negativeCache": { "description": "negative caching", "example": 60, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "primaries": { "description": "primary name server for secondary zone", "example": [ "192.0.2.1" ], "items": { "type": "string" }, "maxItems": 10, "type": "array" }, "primaryNameServer": { "description": "primary name server. FQDN", "example": "example.com", "type": "string" }, "recordCount": { "description": "record count how many records are in the zone", "example": 300, "format": "int32", "minimum": 0, "type": "integer" }, "refreshTime": { "description": "refresh time", "example": 3600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "retryTime": { "description": "retry time", "example": 600, "format": "int32", "maximum": 99999999, "minimum": 60, "type": "integer" }, "serialNumber": { "description": "serial number", "example": 2022111400, "format": "int32", "type": "integer" }, "state": { "description": "zone state", "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "example": "CREATE_SUCCEEDED", "type": "string" }, "type": { "description": "zone type", "enum": [ "primary", "secondary" ], "example": "primary", "type": "string" }, "updateFinished": { "description": "when zone update/deletion finished", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "updateStarted": { "description": "when zone update/deletion started", "example": "2022-01-31 10:00:00+00:00", "type": "string" }, "visibility": { "description": "visibility of the zone", "enum": [ "public" ], "example": "public", "type": "string" } }, "required": [ "acl", "creationFinished", "creationStarted", "defaultTTL", "dnsName", "expireTime", "id", "name", "negativeCache", "primaryNameServer", "refreshTime", "retryTime", "serialNumber", "state", "type", "updateFinished", "updateStarted", "visibility" ], "type": "object" }, "ZoneDataExchange": { "properties": { "rrSets": { "items": { "$ref": "#/components/schemas/RecordDataExchange" }, "type": "array" } }, "type": "object" }, "ZoneResponse": { "description": "ResponseZone for user info.", "properties": { "message": { "example": "Success", "type": "string" }, "zone": { "$ref": "#/components/schemas/Zone" } }, "required": [ "zone" ], "type": "object" }, "domain.Extensions": { "properties": { "observabilityExtension": { "$ref": "#/components/schemas/domain.ObservabilityExtension" } }, "type": "object" }, "domain.ObservabilityExtension": { "properties": { "observabilityInstanceId": { "type": "string" }, "state": { "enum": [ "CREATING", "CREATE_SUCCEEDED", "ERROR" ], "type": "string" } }, "required": [ "observabilityInstanceId" ], "type": "object" }, "zone.Extensions": { "properties": { "observabilityExtension": { "$ref": "#/components/schemas/zone.ObservabilityExtension" } }, "type": "object" }, "zone.ObservabilityExtension": { "properties": { "observabilityInstanceId": { "type": "string" } }, "required": [ "observabilityInstanceId" ], "type": "object" }, "zone_models.ImportRecordModel": { "properties": { "comment": { "example": "comment", "type": "string" }, "content": { "example": [ "192.0.2.1" ], "items": { "type": "string" }, "type": "array" }, "name": { "example": "example.com", "type": "string" }, "ttl": { "example": 3600, "format": "int32", "type": "integer" }, "type": { "example": "A", "type": "string" } }, "type": "object" }, "zone_models.ImportZoneJson": { "properties": { "rrSets": { "items": { "$ref": "#/components/schemas/zone_models.ImportRecordModel" }, "type": "array" } }, "type": "object" } } }, "info": { "contact": { "email": "dns@stackit.cloud", "name": "stackit-dns" }, "description": "This api provides dns", "termsOfService": "https://stackit.de/en/imprint", "title": "STACKIT DNS API", "version": "1.0" }, "openapi": "3.0.1", "paths": { "/v1/dnslookup": { "post": { "description": "allows the user to lookup a domain on the STACKIT DNS Resolvers", "operationId": "LookupDomain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupDomainPayload" } } }, "description": "records to lookup", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupDomainResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "DNS Lookup Route", "x-stackit-authorization": { "disabled": true } } }, "/v1/projects/{projectId}/move-zone": { "post": { "description": "move zone from one project to another", "operationId": "MoveZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveZonePayload" } } }, "description": "information about the move", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "move zone from one project to another", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones": { "get": { "description": "Retrieve all zones. By default, zones in the 'DELETE_SUCCEEDED' state are excluded. To retrieve them, explicitly specify 'state[eq]=DELETE_SUCCEEDED' in the query parameters.", "operationId": "ListZones", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "page", "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, { "description": "page size", "in": "query", "name": "pageSize", "schema": { "default": 100, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "description": "filter dns name equal", "in": "query", "name": "dnsName[eq]", "schema": { "type": "string" } }, { "description": "filter dns name like", "in": "query", "name": "dnsName[like]", "schema": { "type": "string" } }, { "description": "filter type", "in": "query", "name": "type[eq]", "schema": { "enum": [ "primary", "secondary" ], "type": "string" } }, { "description": "filter name equal", "in": "query", "name": "name[eq]", "schema": { "type": "string" } }, { "description": "filter name not equal", "in": "query", "name": "name[neq]", "schema": { "type": "string" } }, { "description": "filter name like", "in": "query", "name": "name[like]", "schema": { "type": "string" } }, { "description": "filter description equal", "in": "query", "name": "description[eq]", "schema": { "type": "string" } }, { "description": "filter description not equal", "in": "query", "name": "description[neq]", "schema": { "type": "string" } }, { "description": "filter description like", "in": "query", "name": "description[like]", "schema": { "type": "string" } }, { "description": "filter state (DELETE_SUCCEEDED is excluded by default)", "in": "query", "name": "state[eq]", "schema": { "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "type": "string" } }, { "description": "filter state", "in": "query", "name": "state[neq]", "schema": { "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "type": "string" } }, { "description": "filter primary name server equal", "in": "query", "name": "primaryNameServer[eq]", "schema": { "type": "string" } }, { "description": "filter primary name server like", "in": "query", "name": "primaryNameServer[like]", "schema": { "type": "string" } }, { "description": "filter reverse zone equal", "in": "query", "name": "isReverseZone[eq]", "schema": { "type": "boolean" } }, { "description": "filter active equal", "in": "query", "name": "active[eq]", "schema": { "type": "boolean" } }, { "description": "filter creation started greater with utc timestamp", "in": "query", "name": "creationStarted[gt]", "schema": { "type": "string" } }, { "description": "filter creation started lesser with utc timestamp", "in": "query", "name": "creationStarted[lt]", "schema": { "type": "string" } }, { "description": "filter creation started greater equal with utc timestamp", "in": "query", "name": "creationStarted[gte]", "schema": { "type": "string" } }, { "description": "filter creation started lesser equal with utc timestamp", "in": "query", "name": "creationStarted[lte]", "schema": { "type": "string" } }, { "description": "filter creation finished greater with utc timestamp", "in": "query", "name": "creationFinished[gt]", "schema": { "type": "string" } }, { "description": "filter creation finished lesser with utc timestamp", "in": "query", "name": "creationFinished[lt]", "schema": { "type": "string" } }, { "description": "filter creation finished greater equal with utc timestamp", "in": "query", "name": "creationFinished[gte]", "schema": { "type": "string" } }, { "description": "filter creation finished lesser equal with utc timestamp", "in": "query", "name": "creationFinished[lte]", "schema": { "type": "string" } }, { "description": "filter update started greater with utc timestamp", "in": "query", "name": "updateStarted[gt]", "schema": { "type": "string" } }, { "description": "filter update started lesser with utc timestamp", "in": "query", "name": "updateStarted[lt]", "schema": { "type": "string" } }, { "description": "filter update started greater equal with utc timestamp", "in": "query", "name": "updateStarted[gte]", "schema": { "type": "string" } }, { "description": "filter update started lesser equal with utc timestamp", "in": "query", "name": "updateStarted[lte]", "schema": { "type": "string" } }, { "description": "filter update finished greater with utc timestamp", "in": "query", "name": "updateFinished[gt]", "schema": { "type": "string" } }, { "description": "filter update finished lesser with utc timestamp", "in": "query", "name": "updateFinished[lt]", "schema": { "type": "string" } }, { "description": "filter update finished greater equal with utc timestamp", "in": "query", "name": "updateFinished[gte]", "schema": { "type": "string" } }, { "description": "filter update finished lesser equal with utc timestamp", "in": "query", "name": "updateFinished[lte]", "schema": { "type": "string" } }, { "description": "filter zones according to the zone label keys.", "explode": false, "in": "query", "name": "labelKey[eq]", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "filter zones according to the zone label values.", "explode": false, "in": "query", "name": "labelValue[eq]", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "order by dns name", "in": "query", "name": "orderBy[dnsName]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by name", "in": "query", "name": "orderBy[name]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by record count", "in": "query", "name": "orderBy[recordCount]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by type", "in": "query", "name": "orderBy[type]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by description", "in": "query", "name": "orderBy[description]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by creationStarted", "in": "query", "name": "orderBy[creationStarted]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by creationFinished", "in": "query", "name": "orderBy[creationFinished]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by updateStarted", "in": "query", "name": "orderBy[updateStarted]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by updateFinished", "in": "query", "name": "orderBy[updateFinished]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZonesResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "All get selected zones", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "post": { "description": "Post zone create a new zone", "operationId": "CreateZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateZonePayload" } } }, "description": "zone to create", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Conflict" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Post create a new zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}": { "delete": { "description": "Delete a zone", "operationId": "DeleteZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Delete a zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "get": { "description": "Get zone", "operationId": "GetZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Get a single zone", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "patch": { "description": "Patch update an existing zone", "operationId": "PartialUpdateZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialUpdateZonePayload" } } }, "description": "zone to update", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Patch update an existing zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/clone": { "post": { "description": "Clone an existing zone with all record sets to a new zone with a different name", "operationId": "CloneZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneZonePayload" } } }, "description": "zone to clone", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Conflict" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Clone an existing zone with all record sets to a new zone with a different name", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/export": { "post": { "description": "Export Zone", "operationId": "ExportRecordSets", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRecordSetsPayload" } } }, "description": "export configuration", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDataExchange" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ZoneDataExchange" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ZoneDataExchange" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Forbidden" } }, "summary": "Export all records in a single zone", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/import": { "post": { "description": "Imports a zone and overwrites/deletes/inserts all desired records", "operationId": "ImportRecordSets", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "format of the data to import", "in": "query", "name": "format", "schema": { "default": "csv", "enum": [ "json", "csv", "bind" ], "type": "string" } }, { "description": "type of the zone import", "in": "query", "name": "importType", "schema": { "default": "restore", "enum": [ "restore", "delete", "update", "upsert" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRecordSetsPayload" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/zone_models.ImportZoneJson" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/zone_models.ImportZoneJson" } } }, "description": "accepts all response bodies for the export endpoint", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRecordSetsResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Forbidden" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Imports a zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/labels": { "get": { "deprecated": true, "description": "All Labels DEPRECATED: Scheduled for sunset on 2027-10-01. Use the labelsMap field in the Zone resource instead.", "operationId": "ListLabels", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLabelsResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Get all labels [DEPRECATED]", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "put": { "deprecated": true, "description": "Create or update label DEPRECATED: Scheduled for sunset on 2027-10-01. Use the labelsMap field in the Zone resource instead.", "operationId": "CreateLabel", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLabelPayload" } } }, "description": "record set to create", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLabelResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Create or update label [DEPRECATED]", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/labels/{key}": { "delete": { "deprecated": true, "description": "Delete a label DEPRECATED: Scheduled for sunset on 2027-10-01. Use the labelsMap field in the Zone resource instead.", "operationId": "DeleteLabel", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "key of the label", "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLabelResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Delete a label [DEPRECATED]", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/move-code": { "delete": { "description": "delete/invalidate a move code", "operationId": "DeleteMoveCode", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "delete/invalidate a move code", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "post": { "description": "move zone from one project to another", "operationId": "CreateMoveCode", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMoveCodePayload" } } }, "description": "information about the movecode" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveCodeResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Conflict" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "request a move code to move zone to another project", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/move-code-validation": { "post": { "description": "validate the move code is still valid for the zone", "operationId": "ValidateMoveCode", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateMoveCodePayload" } } }, "description": "information about the move", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "validate the move code is still valid for the zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/restores": { "post": { "description": "Restore an inactive zone", "operationId": "RestoreZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Restore an inactive zone", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/retrieve": { "post": { "description": "The zone transfer will usually be performed within a few seconds, and will be tried only once by randomly choosing one of the configured primary name servers. If that single attempt fails, no further attempt will be performed. The zone will be transferred to our inbound name server regardless of its serial, but the internal zone distribution is only reliable if the zone's serial on the customer's primary name server is higher than on the STACKIT name server. \u003cbr\u003eNOTE: As said above, this endpoint is not a reliable way to decrease a zone's serial. To guarantee consistent zones over all STACKIT location, the zone's serial MUST always be increased on zone changes.", "operationId": "RetrieveZone", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Queue secondary zone for a zone transfer request.", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/rrsets": { "get": { "description": "Retrieve all RRSets. By default, records in the 'DELETE_SUCCEEDED' state are excluded. To retrieve them, explicitly specify 'state[eq]=DELETE_SUCCEEDED' in the query parameters.", "operationId": "ListRecordSets", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "page", "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, { "description": "page size", "in": "query", "name": "pageSize", "schema": { "default": 100, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "description": "filter name equal", "in": "query", "name": "name[eq]", "schema": { "type": "string" } }, { "description": "filter name like", "in": "query", "name": "name[like]", "schema": { "type": "string" } }, { "description": "filter type", "in": "query", "name": "type[eq]", "schema": { "enum": [ "A", "AAAA", "SOA", "CNAME", "NS", "MX", "TXT", "SRV", "PTR", "ALIAS", "DNAME", "CAA", "DNSKEY", "DS", "LOC", "NAPTR", "SSHFP", "TLSA", "URI", "CERT", "SVCB", "TYPE", "CSYNC", "HINFO", "HTTPS" ], "type": "string" } }, { "description": "filter state (DELETE_SUCCEEDED is excluded by default)", "in": "query", "name": "state[eq]", "schema": { "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "type": "string" } }, { "description": "filter state", "in": "query", "name": "state[neq]", "schema": { "enum": [ "CREATING", "CREATE_SUCCEEDED", "CREATE_FAILED", "DELETING", "DELETE_SUCCEEDED", "DELETE_FAILED", "UPDATING", "UPDATE_SUCCEEDED", "UPDATE_FAILED" ], "type": "string" } }, { "description": "filter active equal", "in": "query", "name": "active[eq]", "schema": { "type": "boolean" } }, { "description": "filter creation started greater with utc timestamp", "in": "query", "name": "creationStarted[gt]", "schema": { "type": "string" } }, { "description": "filter creation started lesser with utc timestamp", "in": "query", "name": "creationStarted[lt]", "schema": { "type": "string" } }, { "description": "filter creation started greater equal with utc timestamp", "in": "query", "name": "creationStarted[gte]", "schema": { "type": "string" } }, { "description": "filter creation started lesser equal with utc timestamp", "in": "query", "name": "creationStarted[lte]", "schema": { "type": "string" } }, { "description": "filter creation finished greater with utc timestamp", "in": "query", "name": "creationFinished[gt]", "schema": { "type": "string" } }, { "description": "filter creation finished lesser with utc timestamp", "in": "query", "name": "creationFinished[lt]", "schema": { "type": "string" } }, { "description": "filter creation finished greater equal with utc timestamp", "in": "query", "name": "creationFinished[gte]", "schema": { "type": "string" } }, { "description": "filter creation finished lesser equal with utc timestamp", "in": "query", "name": "creationFinished[lte]", "schema": { "type": "string" } }, { "description": "filter update started greater with utc timestamp", "in": "query", "name": "updateStarted[gt]", "schema": { "type": "string" } }, { "description": "filter update started lesser with utc timestamp", "in": "query", "name": "updateStarted[lt]", "schema": { "type": "string" } }, { "description": "filter update started greater equal with utc timestamp", "in": "query", "name": "updateStarted[gte]", "schema": { "type": "string" } }, { "description": "filter update started lesser equal with utc timestamp", "in": "query", "name": "updateStarted[lte]", "schema": { "type": "string" } }, { "description": "filter update finished greater with utc timestamp", "in": "query", "name": "updateFinished[gt]", "schema": { "type": "string" } }, { "description": "filter update finished lesser with utc timestamp", "in": "query", "name": "updateFinished[lt]", "schema": { "type": "string" } }, { "description": "filter update finished greater equal with utc timestamp", "in": "query", "name": "updateFinished[gte]", "schema": { "type": "string" } }, { "description": "filter update finished lesser equal with utc timestamp", "in": "query", "name": "updateFinished[lte]", "schema": { "type": "string" } }, { "description": "order by name", "in": "query", "name": "orderBy[name]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by creationStarted", "in": "query", "name": "orderBy[creationStarted]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by creationFinished", "in": "query", "name": "orderBy[creationFinished]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by updateStarted", "in": "query", "name": "orderBy[updateStarted]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by updateFinished", "in": "query", "name": "orderBy[updateFinished]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by type", "in": "query", "name": "orderBy[type]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by state", "in": "query", "name": "orderBy[state]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "order by record count", "in": "query", "name": "orderBy[recordCount]", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRecordSetsResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "All get selected RRSets", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "post": { "description": "Post record set", "operationId": "CreateRecordSet", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRecordSetPayload" } } }, "description": "record set to create", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Conflict" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Post record set", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}": { "delete": { "description": "Delete a record set", "operationId": "DeleteRecordSet", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "record set id", "in": "path", "name": "rrSetId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Delete a record set", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "get": { "description": "Get rrset", "operationId": "GetRecordSet", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "record set id", "in": "path", "name": "rrSetId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Get a single rrset", "x-stackit-authorization": { "actions": [ "dns.zone.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } }, "patch": { "description": "Patch record set", "operationId": "PartialUpdateRecordSet", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "record set id", "in": "path", "name": "rrSetId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialUpdateRecordSetPayload" } } }, "description": "record set to patch", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Patch updates a record set", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/records": { "patch": { "description": "PatchRecords rrset updates a record in a rrset", "operationId": "PartialUpdateRecord", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "record set id", "in": "path", "name": "rrSetId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialUpdateRecordPayload" } } }, "description": "rrset to update", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "PatchRecords updates a record in a rrset", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/restores": { "post": { "description": "Restore record set", "operationId": "RestoreRecordSet", "parameters": [ { "description": "project id", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "zone id", "in": "path", "name": "zoneId", "required": true, "schema": { "type": "string" } }, { "description": "record set id", "in": "path", "name": "rrSetId", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Not Found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Restore record set", "x-stackit-authorization": { "actions": [ "dns.zone.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project", "service-enablement": { "services": [ "cloud.stackit.dns" ] } } } }, "/v1/resolver/flush": { "post": { "description": "allows the user to flush the cache for a domain on the STACKIT DNS Resolvers", "operationId": "FlushDomain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlushDomainPayload" } } }, "description": "domain to flush", "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlushDomainResponse" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" } } }, "description": "Unauthorized" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, "description": "Bad Gateway" } }, "summary": "Flush Route", "x-stackit-authorization": { "disabled": true } } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://dns.api.stackit.cloud", "variables": { "region": { "default": "global" } } } ] }