Proxy HTTP PUT request

Delete API keys

DELETE /users/auth/keys

Delete or invalidate API keys.

Body Required

The request to delete API keys

keys array[string] Required

The list of API key IDs.

Responses

200

The API keys are deleted.

Additional properties are allowed.

DELETE /users/auth/keys

curl \
 --request DELETE https://{{hostname}}/api/v1/users/auth/keys \
 --data '{"keys":["string"]}'

Request examples

{
  "keys": [
    "string"
  ]
}

Response examples (200)

{}

Create a Comment

POST /comments/{resource_type}/{resource_id}

Creates a comment for the given Resource.

Path parameters

resource_type string Required

The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, integrations_server, allocator, constructor, runner, proxy].
resource_id string Required

Id of the Resource that a Comment belongs to.

Body Required

Data for comment creation

message string Required

The message for the Comment.

Responses

201

The Comment that was just created.
Hide headers attributes Show headers attributes
- x-cloud-resource-version string
  
  The resource version, which is used to avoid update conflicts with concurrent operations
- x-cloud-resource-created string
  
  The date-time when the resource was created (ISO format relative to UTC)
- x-cloud-resource-last-modified string
  
  The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attributes Show response attributes object
- id string Required
  
  The id of this Comment
- user_id string Required
  
  The user id of the user who wrote this Comment
- message string Required
  
  The message content of this Comment
401

Your current session does not have a user id associated with it. (code: comments.no_user_id)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is comments.no_user_id.
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

No Resource of the given type and id exist. (code: comments.resource_does_not_exist)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is comments.resource_does_not_exist.
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

A Comment already exists with the generated id. Please try again. (code: comments.id_already_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is comments.id_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

POST /comments/{resource_type}/{resource_id}

curl \
 --request POST https://{{hostname}}/api/v1/comments/{resource_type}/{resource_id} \
 --data '{"message":"string"}'

Request examples

{
  "message": "string"
}

Response examples (201)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "user_id": "string",
  "message": "string"
}

Response examples (401)

# Headers
x-cloud-error-codes: comments.no_user_id

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (404)

# Headers
x-cloud-error-codes: comments.resource_does_not_exist

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (409)

# Headers
x-cloud-error-codes: comments.id_already_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Set AppSearch read-only status

PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode

Enable/Disable read-only mode on the given App Search resource.

Path parameters

deployment_id string Required

Identifier for the Deployment.
ref_id string Required

User-specified RefId for the Resource (or '_main' if there is only one).

Body Required

read-only request body

enabled boolean Required

Enabled or disabled read-only mode

Responses

200

Standard response
Hide response attribute Show response attribute object
- enabled boolean Required
  
  Whether read-only mode is enabled or disabled
404

The Resource specified by ref_id cannot be found. (code: deployments.deployment_resource_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.deployment_resource_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
500

We have failed you. (code: deployments.deployment_resource_no_longer_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.deployment_resource_no_longer_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

PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode

curl \
 --request PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode \
 --data '{"enabled":true}'

Request examples

{
  "enabled": true
}

Response examples (200)

{
  "enabled": true
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_resource_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (500)

# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

Proxies the HTTP PUT request to the deployment resource. You must specify the X-Management-Request HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Headers

X-Management-Request string Required

You must specify the X-Management-Request HTTP header with value true. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Path parameters

deployment_id string Required

Identifier for the Deployment
resource_kind string Required

The kind of resource

Values are elasticsearch, kibana, or enterprise_search.
ref_id string Required

User-specified RefId for the Resource (or '_main' if there is only one)
proxy_path string Required

The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health

Body

The JSON payload to proxy to the deployment resource.

string

Responses

200

The request has been processed successfully through the proxy.
Hide response attribute Show response attribute object
- value string Required
404
- The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
- The Resource specified by {ref_id} cannot be found. (code: clusters.cluster_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or clusters.cluster_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

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

curl \
 --request PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} \
 --header "X-Management-Request: string" \
 --data '"string"'

Request examples

# Headers
X-Management-Request: string

# Payload
string

Response examples (200)

{
  "value": "string"
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}