openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Platform Configuration Networking API
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:
- name: PlatformConfigurationNetworking
paths:
  /platform/configuration/networking/deployment_domain_name:
    get:
      tags:
      - PlatformConfigurationNetworking
      summary: Get default Deployment Domain Name
      description: Gets the default Deployment Domain Name configuration value.
      operationId: get-default-deployment-domain-name
      responses:
        '200':
          description: The Deployment Domain Name was successfully retrieved
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDomainName'
        '404':
          description: 'There is no configured Deployment Domain Name but optimistic locking was sent. (code: `networking.cname.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Networking - Deployment Domain Names
    put:
      tags:
      - PlatformConfigurationNetworking
      summary: Set default Deployment Domain Name
      description: Saves the default Deployment Domain Name configuration value.
      operationId: set-default-deployment-domain-name
      parameters:
      - name: version
        in: query
        description: If specified, then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request). If not specified, will unconditionally upsert.
        required: false
        schema:
          type: string
      - name: skip_cascading_operations
        in: query
        description: Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: The Deployment Domain Name was successfully saved.
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDomainName'
        '400':
          description: 'The optimistic locking version format was wrong. (code: `networking.cname.bad_version_format`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.bad_version_format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '412':
          description: 'skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: `security_deployment.cluster_pending_plan_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.cluster_pending_plan_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'There is no configured Deployment Domain Name but optimistic locking was sent. (code: `networking.cname.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There was an optimistic locking version conflict. (code: `networking.cname.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Networking - Deployment Domain Names
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentDomainName'
        description: Data containing the Deployment Domain Name to set
        required: true
  /platform/configuration/networking/deployment_domain_name/{resource_kind}:
    get:
      tags:
      - PlatformConfigurationNetworking
      summary: Get Deployment Domain Name for a resource kind
      description: Gets Deployment Domain Name configuration value for a resource kind.
      operationId: get-resource-kind-deployment-domain-name
      parameters:
      - name: resource_kind
        in: path
        description: The kind of resource you want to manage a Deployment Domain Name for.
        required: true
        schema:
          type: string
          enum:
          - elasticsearch
          - kibana
          - apm
          - appsearch
          - enterprise_search
          - integrations_server
      responses:
        '200':
          description: The Deployment Domain Name was successfully retrieved
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDomainName'
        '404':
          description: 'There is no configured Deployment Domain Name but optimistic locking was sent. (code: `networking.cname.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Networking - Deployment Domain Names
    put:
      tags:
      - PlatformConfigurationNetworking
      summary: Set Deployment Domain Name for a resource kind.
      description: Saves the Deployment Domain Name configuration value for a resource kind.
      operationId: set-resource-kind-deployment-domain-name
      parameters:
      - name: resource_kind
        in: path
        description: The kind of resource you want to manage a Deployment Domain Name for.
        required: true
        schema:
          type: string
          enum:
          - elasticsearch
          - kibana
          - apm
          - appsearch
          - enterprise_search
          - integrations_server
      - name: version
        in: query
        description: If specified, then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request). If not specified, will unconditionally upsert.
        required: false
        schema:
          type: string
      - name: skip_cascading_operations
        in: query
        description: Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: The Deployment Domain Name was successfully saved.
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentDomainName'
        '400':
          description: 'The optimistic locking version format was wrong. (code: `networking.cname.bad_version_format`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.bad_version_format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '412':
          description: 'skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: `security_deployment.cluster_pending_plan_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.cluster_pending_plan_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'There is no configured Deployment Domain Name but optimistic locking was sent. (code: `networking.cname.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There was an optimistic locking version conflict. (code: `networking.cname.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - networking.cname.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Networking - Deployment Domain Names
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentDomainName'
        description: Data containing the Deployment Domain Name to set
        required: true
components:
  schemas:
    BasicFailedReplyElement:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: A structured code representing the error type that occurred
        message:
          type: string
          description: A human readable message describing the error that occurred
        fields:
          type: array
          description: If the error can be tied to a specific field or fields in the user request, this lists those fields
          items:
            type: string
    DeploymentDomainName:
      type: object
      required:
      - value
      properties:
        value:
          type: string
          description: The domain name for all deployments. The hostname of an application in a deployment is constructed from the application ID and the domain name (for example, 1234567890.example.com).
      description: Deployment domain name configuration
    BasicFailedReply:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          description: A list of errors that occurred in the failing request
          items:
            $ref: '#/components/schemas/BasicFailedReplyElement'
  securitySchemes:
    apiKey:
      type: apiKey
      name: Authorization
      in: header
    basicAuth:
      type: http
      scheme: basic
x-elastic:
  curl:
    auth: '-H "Authorization: ApiKey $ECE_API_KEY"'