openapi: 3.2.0
info:
  description: Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/fusion-applications/home.htm).
  title: Fusion Applications Environment Management Vanity Domain API
  version: '20211201'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Fusion Applications Environment Management API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml
    what: the harvested document for Fusion Applications Environment Management API
servers:
- url: http://127.0.0.1/20211201
- url: https://127.0.0.1/20211201
tags:
- name: vanityDomain
paths:
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomainActivities:
    post:
      description: 'Create a VanityDomainActivity

        '
      operationId: CreateVanityDomainActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The VanityDomainActivity will be created.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
            vanity-activity-id:
              description: The scheduled Vanity Domain Activity identifier.
              schema:
                type: string
        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: Create a VanityDomainActivity
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomainActivity'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVanityDomainActivityDetails'
        description: The Certificate Details of Vanity Domain Activity
        required: true
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomainActivities/{vanityDomainActivityId}:
    delete:
      description: 'Deletes a VanityDomainActivity

        '
      operationId: DeleteVanityDomainActivity
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/VanityDomainActivityIdentifierPathParam'
      responses:
        202:
          description: Scheduled VanityDomainActivity was deleted.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes VanityDomainActivity
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomainActivity'
    get:
      description: 'Gets a VanityDomainActivity

        '
      operationId: GetVanityDomainActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/VanityDomainActivityIdentifierPathParam'
      responses:
        200:
          description: Retrieves the VanityDomainActivity with the given id
          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/VanityDomainActivity'
        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: Gets VanityDomainActivity
      tags:
      - vanityDomain
    put:
      description: 'Updates a VanityDomainActivity

        '
      operationId: UpdateVanityDomainActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/VanityDomainActivityIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Scheduled VanityDomainActivity was updated.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates VanityDomainActivity
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomainActivity'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVanityDomainActivityDetails'
        description: Details for the updating scheduled VanityDomainActivity
        required: true
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomains:
    get:
      description: 'Lists all VanityDomains.

        '
      operationId: ListVanityDomains
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IsFullVanityQueryParam'
      responses:
        200:
          description: A page of VanityDomainSummary objects.
          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/VanityDomainCollection'
        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: Lists all VanityDomains
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomain'
    post:
      description: 'Create a VanityDomain

        '
      operationId: CreateVanityDomain
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The VanityDomain is created.
          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 status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VanityDomain'
        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: Create a VanityDomain
      tags:
      - vanityDomain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVanityDomainDetails'
        description: The VanityDomain to be created.
        required: true
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}:
    get:
      description: 'Gets a VanityDomain

        '
      operationId: GetVanityDomain
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/VanityDomainIdentifierPathParam'
      - $ref: '#/components/parameters/DoesDownloadOriginCsrQueryParam'
      - $ref: '#/components/parameters/DoesDownloadAkamaiCsrQueryParam'
      responses:
        200:
          description: Retrieves the VanityDomain with the given id
          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/VanityDomain'
        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: Get VanityDomain
      tags:
      - vanityDomain
    put:
      description: 'Updates a VanityDomain

        '
      operationId: UpdateVanityDomain
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/VanityDomainIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Scheduled VanityDomain was updated.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates VanityDomain
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVanityDomainDetails'
        description: Details for the updating scheduled VanityDomain
        required: true
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}/actions/submitValidation:
    post:
      description: 'Submit Vanity Domain Validation

        '
      operationId: SubmitVanityDomainValidation
      parameters:
      - $ref: '#/components/parameters/VanityDomainIdentifierPathParam'
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The VanityDomain will be validated.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Submit Vanity Domain Validation
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomain'
  /fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}/actions/uploadCertificate:
    post:
      description: 'Upload Vanity Domain certificate

        '
      operationId: UploadVanityDomainCertificate
      parameters:
      - $ref: '#/components/parameters/VanityDomainIdentifierPathParam'
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The VanityDomain will be uploaded.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Upload Vanity Domain certificate
      tags:
      - vanityDomain
      x-related-resource: '#/definitions/VanityDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadVanityDomainCertificateDetails'
        description: The Certificate Details of Vanity Domain to be uploaded
        required: true
components:
  schemas:
    CertificateInfo:
      description: Properties of certificate
      properties:
        akamaiCsr:
          description: Akamai Certificate signing request
          type: string
        akamaiDvCertInstruction:
          description: Akamai Dv Cert instruction to validate domain, e.g. set DNS token or HTTP token, etc
          type: string
        commonName:
          description: Fully qualified host name
          type: string
        country:
          description: Country name
          type: string
        emailAddress:
          description: Email address
          type: string
        firstName:
          description: First name
          type: string
        lastName:
          description: Last name
          type: string
        locality:
          description: City
          type: string
        organizationName:
          description: Company name
          type: string
        organizationUnit:
          description: Company section
          type: string
        originCsr:
          description: Certificate signing request
          type: string
        originDvCertInstruction:
          description: Dv Cert instruction to validate domain, e.g. set DNS token or HTTP token, etc
          type: string
        phoneNumber:
          description: Phone number
          type: string
        postalCode:
          description: Postal code
          type: string
        state:
          description: State or province
          type: string
        subjectAltNames:
          description: List of subject alternative names, comma separated
          items:
            type: string
          type: array
      type: object
    VanityDomainCollection:
      description: Results of a VanityDomain search
      properties:
        items:
          description: A page of VanityDomainSummary objects
          items:
            $ref: '#/components/schemas/VanityDomainSummary'
          type: array
      required:
      - items
      type: object
    UpdateVanityDomainActivityDetails:
      description: The information about scheduled refresh.
      properties:
        timeScheduled:
          description: Expected activity start time
          format: date-time
          type: string
      type: object
    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
    CreateVanityDomainDetails:
      description: Vanity domain request detail
      properties:
        cdnCertRequestType:
          description: The cdn request type for which the certificate is generated
          enum:
          - REQUEST_CSR
          - REQUEST_DV
          type: string
        certificateInfo:
          $ref: '#/components/schemas/CertificateInfo'
        changeManagementLink:
          description: The cm link that was used to create the DNS prefix
          type: string
        dnsManagedBy:
          description: The dns is managed by the customer or Oracle
          enum:
          - ORACLE_MANAGED
          - CUSTOMER_MANAGED
          type: string
        originCertRequestType:
          description: The origin request type for which the certificate is generated
          enum:
          - REQUEST_CSR
          - REQUEST_DV
          type: string
        prefix:
          description: The prefix value of the DnsPrefix. Can't be changed after creation
          type: string
        vanityDomain:
          description: Vanity domain
          type: string
      type: object
    CreateVanityDomainActivityDetails:
      description: Schedule activity details to vanity domain on pod
      properties:
        operationType:
          description: The type of operation
          enum:
          - ENABLE_VANITY_DOMAIN
          - DELETE_VANITY_DOMAIN
          type: string
        timeScheduled:
          description: Activity start time
          format: date-time
          type: string
        vanityDomainId:
          description: Vanity domain ID
          type: string
      required:
      - vanityDomainId
      - timeScheduled
      - operationType
      type: object
    UploadVanityDomainCertificateDetails:
      description: Add vanity domain with certificate
      properties:
        certificateChainPem:
          description: Certificate chain PEM, including intermediate and root
          type: string
        certificatePem:
          description: Public certificate PEM
          type: string
        commonName:
          description: Fully qualified host name
          type: string
        isAkamai:
          description: Identify if this is certificate for pod LB or Akamai
          type: boolean
      required:
      - isAkamai
      - commonName
      - certificatePem
      type: object
    VanityDomain:
      description: Vanity Domain resource
      properties:
        cdnCertRequestType:
          description: The cdn request type for which the certificate is generated
          enum:
          - REQUEST_CSR
          - REQUEST_DV
          type: string
        cdnCertStatus:
          description: The cdn cert status
          enum:
          - ACTIVE
          - INACTIVE
          - EXPIRING
          - EXPIRED
          type: string
        certificateInfo:
          $ref: '#/components/schemas/CertificateInfo'
        changeManagementLink:
          description: The cm link that was used to create the DNS prefix
          type: string
        customerDnsRecords:
          description: List of dns records, comma separated
          items:
            $ref: '#/components/schemas/VanityDnsRecord'
          type: array
        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
        dnsManagedBy:
          description: The dns is managed by the customer or Oracle
          enum:
          - ORACLE_MANAGED
          - CUSTOMER_MANAGED
          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
        fusionEnvironmentId:
          description: The OCID of the Fusion environment that the VanityDomain is created on
          type: string
        id:
          description: The unique identifier (OCID) of the VanityDomain. Can't be changed after creation
          type: string
        isCdnCertStatusReady:
          description: Identify if this cdn cert is inactive or active
          type: boolean
        isDnsStatusReady:
          description: Identify if this dns is inactive or active
          type: boolean
        isOriginCertStatusReady:
          description: Identify if this origin cert is inactive or active
          type: boolean
        lifecycleDetails:
          description: The current lifecycleDetails of the VanityDomain
          enum:
          - NONE
          - DOMAIN_VALIDATION_IN_PROGRESS
          - DOMAIN_VALIDATION_COMPLETED
          - DOMAIN_VALIDATION_FAILED
          - CERT_CONFIG_IN_PROGRESS
          - CERT_CONFIG_COMPLETED
          - CERT_CONFIG_FAILED
          - CDN_CERT_CONFIG_IN_PROGRESS
          - CDN_CERT_CONFIG_COMPLETED
          - CDN_CERT_CONFIG_FAILED
          - ENABLE_SCHEDULED
          - ENABLING
          - ENABLED
          - ENABLE_FAILED
          - ENABLE_CANCELLED
          - DELETE_FAILED
          - UNKNOWN
          type: string
        lifecycleState:
          description: The current lifecycleState of the VanityDomain
          enum:
          - INACTIVE
          - ACTIVE
          - UPDATING
          - NEEDS_ATTENTION
          - DELETING
          - DELETED
          - FAILED
          type: string
        originCertRequestType:
          description: The origin request type for which the certificate is generated
          enum:
          - REQUEST_CSR
          - REQUEST_DV
          type: string
        originCertStatus:
          description: The origin cert status
          enum:
          - ACTIVE
          - INACTIVE
          - EXPIRING
          - EXPIRED
          type: string
        prefix:
          description: The prefix value of the DnsPrefix. Can't be changed after creation
          type: string
        scheduledActivityId:
          description: The ID of the VanityDomainActivity is scheduled
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCdnCertExpired:
          description: The cdn cert expiry date
          format: date-time
          type: string
        timeCreated:
          description: The time the VanityDomain was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeEnabled:
          description: The time the VanityDomain is scheduled to enable. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeOriginCertExpired:
          description: The origin cert expiry date
          format: date-time
          type: string
        timeUpdated:
          description: The time the VanityDomain was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        vanityDomain:
          description: Vanity domain
          type: string
      required:
      - id
      - vanityDomain
      - fusionEnvironmentId
      - lifecycleState
      - lifecycleDetails
      - timeCreated
      - timeUpdated
      - timeEnabled
      - systemTags
      - freeformTags
      - definedTags
      type: object
    VanityDomainActivity:
      description: Vanity Domain Activity resource
      properties:
        fusionEnvironmentId:
          description: The OCID of the Fusion environment that the VanityDomainActivity is created on
          type: string
        id:
          description: The unique identifier (OCID) of the VanityDomainActivity. Can't be changed after creation
          type: string
        lifecycleDetails:
          description: The current lifecycleDetails of the VanityDomainActivity
          enum:
          - NONE
          type: string
        lifecycleState:
          description: The current lifecycleState of the VanityDomainActivity
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELED
          - NEEDS_ATTENTION
          type: string
        operationType:
          description: The type of operation
          enum:
          - ENABLE_VANITY_DOMAIN
          - DELETE_VANITY_DOMAIN
          type: string
        timeCreated:
          description: The time the VanityDomainactivity was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeDeactivated:
          description: The time the VanityDomainactivity is scheduled to deactivate. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeEnabled:
          description: The time the VanityDomainactivity is scheduled to enable. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeScheduled:
          description: Activity start time
          format: date-time
          type: string
        timeUpdated:
          description: The time the VanityDomainactivity was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        vanityDomainId:
          description: Vanity domain ID
          type: string
      required:
      - id
      - vanityDomainId
      - fusionEnvironmentId
      - lifecycleState
      - lifecycleDetails
      - timeCreated
      - timeUpdated
      - timeEnabled
      - timeDeactivated
      - timeScheduled
      - operationType
      type: object
    VanityDnsRecord:
      description: DNS record for vanity domain
      properties:
        domain:
          description: domain name for dns record
          type: string
        rdata:
          description: dns server hostname is pointed to
          type: string
        ttlInSeconds:
          description: time to live for dns record
          type: integer
        type:
          description: record data for record type
          type: string
      required:
      - domain
      - rdata
      - type
      - ttlInSeconds
      type: object
    VanityDomainSummary:
      description: Summary of the VanityDomain
      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
        fusionEnvironmentId:
          description: The OCID of the Fusion environment that the VanityDomain is created on
          type: string
        id:
          description: The unique identifier (OCID) of the VanityDomain. Can't be changed after creation
          type: string
        lifecycleDetails:
          description: The current lifecycleDetails of the VanityDomain
          type: string
          x-obmcs-enumref: '#/definitions/VanityDomain/lifecycleDetails'
        lifecycleState:
          description: The current lifecycleState of the VanityDomain
          type: string
          x-obmcs-enumref: '#/definitions/VanityDomain/lifecycleState'
        prefix:
          description: The prefix value of the DnsPrefix. Can't be changed after creation
          type: string
        scheduledActivityId:
          description: The ID of the VanityDomainActivity is scheduled
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: The time the VanityDomain was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeEnabled:
          description: The time the VanityDomain is scheduled to enable. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the VanityDomain was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        vanityDomain:
          description: Vanity domain. Can't be changed after creation
          type: string
      required:
      - id
      - vanityDomain
      - fusionEnvironmentId
      - lifecycleState
      - lifecycleDetails
      - timeCreated
      - timeUpdated
      - timeEnabled
      - systemTags
      - freeformTags
      - definedTags
      type: object
    UpdateVanityDomainDetails:
      description: The information about scheduled VanityDomain refresh.
      properties:
        certificateInfo:
          $ref: '#/components/schemas/CertificateInfo'
      type: object
  parameters:
    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
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIME_CREATED
        - DISPLAY_NAME
        default: TIME_CREATED
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    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
    VanityDomainIdentifierPathParam:
      description: The unique identifier (OCID) of the VanityDomain
      in: path
      name: vanityDomainId
      required: true
      schema:
        type: string
    DoesDownloadOriginCsrQueryParam:
      description: A parameter indicating whether to download the Origin Csr or not
      in: query
      name: doesDownloadOriginCsr
      required: false
      x-default-description: default = false
      schema:
        type: boolean
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 100
        minimum: 1
    DoesDownloadAkamaiCsrQueryParam:
      description: A parameter indicating whether to download the Akamai Csr or not
      in: query
      name: doesDownloadAkamaiCsr
      required: false
      x-default-description: default = false
      schema:
        type: boolean
    IsFullVanityQueryParam:
      description: The boolean filter to distinguish prefix or full vanity
      in: query
      name: isFullVanityDomain
      required: true
      schema:
        type: boolean
    FusionEnvironmentIdentifierPathParam:
      description: unique FusionEnvironment identifier
      in: path
      name: fusionEnvironmentId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    VanityDomainActivityIdentifierPathParam:
      description: The unique identifier (OCID) of the VanityDomainActivity
      in: path
      name: vanityDomainActivityId
      required: true
      schema:
        type: string
    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

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  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-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.
      format: float
      type: number
  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:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{orcl-cloud: {free-tier-retain: true}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.facontrolplane