Verify domain claim

POST /organizations/{organization_id}/domains/_verify

Verify domain claim challenge.

Path parameters

application/json

Body Required

The verification code request

Responses

  • 200 application/json

    With status 200 ok to signal the domain has been claimed
  • 400 application/json

    Domain claim already exists. (code: org.domain_claim.already_exists)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is org.domain_claim.already_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 404 application/json

    Organization not found. (code: organization.not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is organization.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 409 application/json

    Concurrent organization modification. (code: org.domain_claim.concurrent_organization_modification)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is org.domain_claim.concurrent_organization_modification.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 449 application/json

    The challenge can not be verified at the moment, please retry later
POST /organizations/{organization_id}/domains/_verify 
curl \
 --request POST https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/domains/_verify \
 --header "Content-Type: application/json" \
 --data '{"domain_claim_request":"string"}'
Request examples 
{
  "domain_claim_request": "string"
}
Response examples (200) 
{}
Response examples (400) 
# Headers
x-cloud-error-codes: org.domain_claim.already_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
# Headers
x-cloud-error-codes: organization.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409) 
# Headers
x-cloud-error-codes: org.domain_claim.concurrent_organization_modification

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (449) 
{}