r2_list_custom_domains_response

APIs.ioEngineeringPlatform

Properties

Name Type Description
domains array
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-r2-list-custom-domains-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/r2_list_custom_domains_response",
  "title": "r2_list_custom_domains_response",
  "example": {
    "domains": [
      {
        "domain": "prefix.example-domain.one.com",
        "enabled": false,
        "status": {
          "ownership": "deactivated",
          "ssl": "pending"
        },
        "zoneId": "36ca64a6d92827b8a6b90be344bb1bfd",
        "zoneName": "example-domain.one.com"
      },
      {
        "domain": "prefix.example-domain.two.com",
        "enabled": true,
        "status": {
          "ownership": "active",
          "ssl": "active"
        },
        "zoneId": "d9d28585d5f8f5b0f857b055bf574f19"
      }
    ]
  },
  "properties": {
    "domains": {
      "items": {
        "properties": {
          "domain": {
            "description": "Domain name of the custom domain to be added",
            "type": "string"
          },
          "enabled": {
            "description": "Whether this bucket is publicly accessible at the specified custom domain",
            "type": "boolean"
          },
          "minTLS": {
            "description": "Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.",
            "enum": [
              "1.0",
              "1.1",
              "1.2",
              "1.3"
            ],
            "type": "string"
          },
          "status": {
            "properties": {
              "ownership": {
                "description": "Ownership status of the domain",
                "enum": [
                  "pending",
                  "active",
                  "deactivated",
                  "blocked",
                  "error",
                  "unknown"
                ],
                "type": "string"
              },
              "ssl": {
                "description": "SSL certificate status",
                "enum": [
                  "initializing",
                  "pending",
                  "active",
                  "deactivated",
                  "error",
                  "unknown"
                ],
                "type": "string"
              }
            },
            "required": [
              "ssl",
              "ownership"
            ],
            "type": "object"
          },
          "zoneId": {
            "description": "Zone ID of the custom domain resides in",
            "type": "string"
          },
          "zoneName": {
            "description": "Zone that the custom domain resides in",
            "type": "string"
          }
        },
        "required": [
          "domain",
          "status",
          "enabled"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "domains"
  ],
  "type": "object"
}