Oracle Domain API

openapi: 3.2.0
info:
  title: Oracle Domain API
  version: '1.0'
  description: 'Operations tagged domain across 2 of this provider''s published API definitions: oci-organizations-1-openapi.yaml, oci-organizations-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1/20220518
- url: https://127.0.0.1/20220518
tags:
- name: domain
paths:
  /domains:
    get:
      description: 'Return a (paginated) list of domains.

        '
      operationId: ListDomains
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DomainIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DomainStatusQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of domains.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists domains
      tags:
      - domain
      x-related-resource: '#/definitions/Domain'
    post:
      description: Begins the registration process for claiming a domain.
      operationId: CreateDomain
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: Domain creation accepted.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Begins the registration process for claiming a domain.
      tags:
      - domain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainDetails'
        description: Parameters for domain creation.
        required: true
  /domains/{domainId}:
    delete:
      description: Releases the domain, making it available to be claimed again by another tenancy.
      operationId: DeleteDomain
      parameters:
      - $ref: '#/components/parameters/DomainIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Domain release process started.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Releases the domain, making it available to be claimed again by another tenancy.
      tags:
      - domain
      x-related-resource: '#/definitions/Domain'
    get:
      description: Gets information about the domain.
      operationId: GetDomain
      parameters:
      - $ref: '#/components/parameters/DomainIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Domain retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets information about the domain.
      tags:
      - domain
    put:
      description: Updates the domain.
      operationId: UpdateDomain
      parameters:
      - $ref: '#/components/parameters/DomainIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Domain updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the domain identified by the ID.
      tags:
      - domain
      x-related-resource: '#/definitions/Domain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainDetails'
        description: The information to be updated.
        required: true
components:
  parameters:
    NameQueryParam:
      description: A filter to return only resources that exactly match the name given.
      in: query
      name: name
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order can be provided.

        * The default order for timeCreated is descending.

        * The default order for displayName is ascending.

        * If no value is specified, timeCreated is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    DomainStatusQueryParam:
      description: The status of the domain.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/Domain/status'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, whether 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: The default order depends on what parameter is being sorted by.
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    DomainIdPathParam:
      description: The domain OCID.
      in: path
      name: domainId
      required: true
      schema:
        type: string
        maxLength: 255
    DomainIdQueryParam:
      description: The domain OCID.
      in: query
      name: domainId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request, so it can be retried in case of a timeout or

        server error, without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        will be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    LifecycleStateQueryParam:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - ACTIVE
        - INACTIVE
        - UPDATING
        - FAILED
        - TERMINATED
  schemas:
    CreateDomainDetails:
      description: The parameters for creating a domain.
      properties:
        compartmentId:
          description: OCID of the tenancy.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        domainName:
          description: The domain name.
          example: example.com
          maxLength: 253
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        isGovernanceEnabled:
          description: Indicates whether governance should be enabled for this domain. Defaults to false.
          type: boolean
        subscriptionEmail:
          description: Email address to be used to notify the user, and that the ONS subscription will be created with.
          maxLength: 255
          minLength: 6
          type: string
      required:
      - compartmentId
      - domainName
    Error:
      description: Error information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    DomainSummary:
      description: The summary of a domain owned by a tenancy.
      properties:
        compartmentId:
          description: The OCID of the tenancy that has started the registration process for this domain.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        domainName:
          description: The domain name.
          example: example.com
          maxLength: 253
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: OCID of the domain.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the domain.
          example: ACTIVE
          type: string
          x-obmcs-enumref: '#/definitions/Domain/lifecycleState'
        ownerId:
          description: The OCID of the tenancy that has started the registration process for this domain.
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: Status of the domain.
          example: PENDING
          type: string
          x-obmcs-enumref: '#/definitions/Domain/status'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: Date-time when this domain was created. An RFC 3339-formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        txtRecord:
          description: The code that the owner of the domain will need to add as a TXT record to their domain.
          example: oci-domain-verification=exampleEncodedToken
          maxLength: 45
          minLength: 40
          type: string
      required:
      - id
      - domainName
      - ownerId
      - compartmentId
      - lifecycleState
      - status
      - txtRecord
    Domain:
      description: The domain model that is associated with a tenancy.
      properties:
        compartmentId:
          description: The OCID of the tenancy that has started the registration process for this domain.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        domainName:
          description: The domain name.
          example: example.com
          maxLength: 253
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The OCID of the domain.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the domain.
          enum:
          - ACTIVE
          - DELETED
          - FAILED
          example: ACTIVE
          type: string
        ownerId:
          description: The OCID of the tenancy that has started the registration process for this domain.
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: Status of the domain.
          enum:
          - PENDING
          - RELEASING
          - RELEASED
          - EXPIRING
          - REVOKING
          - REVOKED
          - ACTIVE
          - FAILED
          example: PENDING
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: Date-time when this domain was created. An RFC 3339-formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        txtRecord:
          description: The code that the owner of the domain will need to add as a TXT record to their domain.
          example: oci-domain-verification=exampleEncodedToken
          maxLength: 45
          minLength: 40
          type: string
      required:
      - id
      - domainName
      - ownerId
      - lifecycleState
      - status
      - txtRecord
    DomainCollection:
      description: Result of a query request for a list of domains. Contains DomainSummary items.
      properties:
        items:
          description: Array containing DomainSummary items.
          items:
            $ref: '#/components/schemas/DomainSummary'
          type: array
      required:
      - items
      type: object
    UpdateDomainDetails:
      description: The parameters for updating a domain.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- oci-organizations-1-openapi.yaml
- oci-organizations-openapi.yaml
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.idm.agcs.cp