Authorizations
Path Parameters
(Required) The API Key ID.
Example:
"<string>"
Response
The API key metadata is retrieved.
API Documentation
Endpoint Examples
account
billing
- GETGet charts for the organization. Currently unavailable in self-hosted ECE.
- GETGet charts by deployment. Currently unavailable in self-hosted ECE.
- GETGet itemized costs by deployments. Currently unavailable in self-hosted ECE.
- GETGet deployments costs for the organization. Currently unavailable in self-hosted ECE.
- GETGet itemized costs for the organization. Currently unavailable in self-hosted ECE.
- GETGet costs overview for the organization. Currently unavailable in self-hosted ECE.
deployments1
- POSTSearch Deployments
- POSTGet eligible remote clusters
- GETGet Extension
- PUTUploads the Extension
- POSTUpdate Extension
- DELDelete Extension
- GETList Extensions
- POSTCreate an extension
- GETGet deployment template
- GETGet deployment templates
- GETGet associated rulesets
- POSTClaim a link id
- POSTUnclaims a link id
- GETList traffic filter claimed link id
- DELDelete ruleset association
- GETGet associated deployments
- POSTCreate ruleset association
- GETRetrieves the ruleset by ID.
- PUTUpdates a ruleset
- DELDelete a ruleset
- GETList traffic filter rulesets
- POSTCreate a ruleset
- POSTRestores a shutdown Deployment
- POSTShuts down Deployment
- POSTReset the secret token for an APM resource.
- GETGet Deployment APM Resource Info
- GETSet AppSearch read-only status
- PUTSet AppSearch read-only status
- GETGet Deployment App Search Resource Info
- GETGet certificate authority
- POSTMigrate Elasticsearch and associated Kibana resources to enable CCR
- POSTMigrate Elasticsearch resource to use ILM
- POSTMigrate Elasticsearch resource to use SLM
- POSTReset 'elastic' user password
- POSTRestart Deployment Elasticsearch Resource
- POSTShutdown Deployment Elasticsearch Resource
- POSTGet eligible remote clusters
- GETGet the items in the Elasticsearch resource keystore
- PATCHAdd or remove items from the Elasticsearch resource keystore
- GETGet certificate based remote clusters
- PUTSet certificate based remote clusters
- GETGet Deployment Elasticsearch Resource Info
- GETGet Deployment Enterprise Search Resource Info
- GETGet Deployment Integrations Server Resource Info
- GETGet Deployment Kibana Resource Info
- GETBuild request to migrate deployment to a different template
- GETGet Deployment upgade assistant status
- POSTRestores a shutdown resource
- POSTStart all instances
- POSTStop all instances
- POSTStart maintenance mode (all instances)
- POSTStop maintenance mode (all instances)
- POSTStart instances
- POSTStop instances
- POSTStart maintenance mode
- POSTStop maintenance mode
- DELCancel resource pending plan
- POSTRestart Deployment Stateless Resource
- POSTShutdown Deployment Stateless Resource
- POSTUpgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment
- GETGet Deployment
- PUTUpdate Deployment
- GETList Deployments
- POSTCreate Deployment
organizations
- POSTAccept an organization invitation
- GETGet organization invitation
- DELDelete organization invitations
- GETList organization invitations
- POSTCreate organization invitations
- DELDelete organization memberships
- GETList organization members
- GETFetch organization information
- PUTUpdate organization
- GETList organizations
trusted-environments
Get API key
Copy
curl --request GET \
--url https://api.elastic-cloud.com/api/v1/users/auth/keys/{api_key_id} \
--header 'Authorization: <api-key>'Copy
{
"creation_date": "<dateTime>",
"description": "<string>",
"expiration_date": "<dateTime>",
"id": "<string>",
"key": "<string>",
"organization_id": "<string>",
"role_assignments": {
"deployment": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"deployment_ids": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"deployment_ids": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"role_id": "<string>"
}
],
"organization": [
{
"organization_id": "<string>",
"role_id": "<string>"
},
{
"organization_id": "<string>",
"role_id": "<string>"
}
],
"platform": [
{
"role_id": "<string>"
},
{
"role_id": "<string>"
}
],
"project": {
"elasticsearch": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
],
"observability": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
],
"security": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
]
}
},
"user_id": "<string>"
}users
Get API key
Retrieves the metadata for an API key.
GET
/
users
/
auth
/
keys
/
{api_key_id}
Get API key
Copy
curl --request GET \
--url https://api.elastic-cloud.com/api/v1/users/auth/keys/{api_key_id} \
--header 'Authorization: <api-key>'Copy
{
"creation_date": "<dateTime>",
"description": "<string>",
"expiration_date": "<dateTime>",
"id": "<string>",
"key": "<string>",
"organization_id": "<string>",
"role_assignments": {
"deployment": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"deployment_ids": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"deployment_ids": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"role_id": "<string>"
}
],
"organization": [
{
"organization_id": "<string>",
"role_id": "<string>"
},
{
"organization_id": "<string>",
"role_id": "<string>"
}
],
"platform": [
{
"role_id": "<string>"
},
{
"role_id": "<string>"
}
],
"project": {
"elasticsearch": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
],
"observability": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
],
"security": [
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": [
"<string>",
"<string>"
],
"organization_id": "<string>",
"project_ids": [
"<string>",
"<string>"
],
"role_id": "<string>"
}
]
}
},
"user_id": "<string>"
}⌘I