Elastic Cloud Enterprise API
This RESTful API enables you to create and manage both your Elastic Stack deployments and the ECE platform.
This documentation applies to the Elastic Cloud Enterprise API only. If you are using Elasticsearch Service, use the Elastic Cloud API.
This API supports both key-based and token-based authentication. Key-based is generally the preferred method. For details about creating an API key or bearer token, refer to Authentication.
In this documentation, {{hostname}} refers to the coordinating host (any host with the coordinator role). You can specify either its hostname or its IP address.
- Version
- 1
This documentation applies to Elastic Cloud Enterprise version 4.2. It is derived from https://api.elastic-cloud.com/api/v1/api-docs/swagger.json. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.
Accounts 3
Authentication 18
-
GET
User authentication information
/users/auth -
POST
Login to ECE
/users/auth/_login -
POST
Logout from ECE
/users/auth/_logout -
POST
Refresh authentication token
/users/auth/_refresh -
GET
Get all API keys
/users/auth/keys -
POST
Create API key
/users/auth/keys -
DELETE
Delete API keys
/users/auth/keys -
GET
Get all API keys for all users
/users/auth/keys/_all -
DELETE
Delete API keys of multiple users
/users/auth/keys/_all -
GET
Get API key
/users/auth/keys/{api_key_id} -
DELETE
Delete API key
/users/auth/keys/{api_key_id} -
GET
Available authentication methods
/users/auth/methods -
POST
SAML callback
/users/auth/saml/_callback -
GET
Initiate SAML protocol
/users/auth/saml/_init -
GET
Get API key metadata for all keys created by the user
/users/{user_id}/auth/keys -
DELETE
Delete API keys for a user
/users/{user_id}/auth/keys -
GET
Get a user API key
/users/{user_id}/auth/keys/{api_key_id} -
DELETE
Delete an API key for a user
/users/{user_id}/auth/keys/{api_key_id}
Billing costs analysis 6
-
GET
Get costs overview for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id} -
GET
Get charts for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/charts -
GET
Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments -
GET
Get charts by deployment. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments/{deployment_id}/charts -
GET
Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/deployments/{deployment_id}/items -
GET
Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
/billing/costs/{organization_id}/items
Comments 5
-
GET
List Comments
/comments/{resource_type}/{resource_id} -
POST
Create a Comment
/comments/{resource_type}/{resource_id} -
GET
Get Comment
/comments/{resource_type}/{resource_id}/{comment_id} -
PUT
Update Comment
/comments/{resource_type}/{resource_id}/{comment_id} -
DELETE
Delete Comment
/comments/{resource_type}/{resource_id}/{comment_id}
Deployments 73
-
GET
List Deployments
/deployments -
POST
Create Deployment
/deployments -
POST
Resynchronize Deployments
/deployments/_resync -
POST
Search Deployments
/deployments/_search -
POST
Get eligible remote clusters
/deployments/eligible-remote-clusters -
GET
Get Deployment
/deployments/{deployment_id} -
PUT
Update Deployment
/deployments/{deployment_id} -
DELETE
Delete Deployment
/deployments/{deployment_id} -
POST
Restores a shutdown Deployment
/deployments/{deployment_id}/_restore -
POST
Resynchronize Deployment
/deployments/{deployment_id}/_resync -
POST
Shuts down Deployment
/deployments/{deployment_id}/_shutdown -
GET
Get Deployment APM Resource Info
/deployments/{deployment_id}/apm/{ref_id} -
POST
Reset the secret token for an APM resource.
/deployments/{deployment_id}/apm/{ref_id}/_reset-token -
GET
Get Deployment App Search Resource Info
/deployments/{deployment_id}/appsearch/{ref_id} -
GET
Set AppSearch read-only status
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode -
PUT
Set AppSearch read-only status
/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode -
POST
Migrate Deployment BYOK
/deployments/{deployment_id}/byok-migration -
GET
Get certificate authority
/deployments/{deployment_id}/certificate-authority -
GET
Get Deployment Elasticsearch Resource Info
/deployments/{deployment_id}/elasticsearch/{ref_id} -
POST
Migrate Elasticsearch and associated Kibana resources to enable CCR
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr -
POST
Migrate Elasticsearch resource to use ILM
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm -
POST
Migrate Elasticsearch resource to use SLM
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm -
POST
Reset 'elastic' user password
/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password -
POST
Restart Deployment Elasticsearch Resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart -
POST
Shutdown Deployment Elasticsearch Resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown -
POST
Get eligible remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters -
POST
Move Elasticsearch resource instances
/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move -
GET
Get the items in the Elasticsearch resource keystore
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore -
PATCH
Add or remove items from the Elasticsearch resource keystore
/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore -
GET
Get certificate based remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters -
PUT
Set certificate based remote clusters
/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters -
GET
List the attached snapshot repositories
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository -
POST
Create a snapshot repository for Elasticsearch resource
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository -
DELETE
Remove the attached snapshot repository
/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name} -
GET
Get Elasticsearch tiers
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers -
PATCH
Update Elasticsearch tiers
/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers -
GET
Get Deployment Enterprise Search Resource Info
/deployments/{deployment_id}/enterprise_search/{ref_id} -
GET
Get details about heap dumps for a Deployment
/deployments/{deployment_id}/heap_dumps -
GET
Get Deployment Integrations Server Resource Info
/deployments/{deployment_id}/integrations_server/{ref_id} -
GET
Get Deployment Kibana Resource Info
/deployments/{deployment_id}/kibana/{ref_id} -
GET
Build request to migrate deployment to a different template
/deployments/{deployment_id}/migrate_template -
GET
Get the tags for a Deployment
/deployments/{deployment_id}/tags -
PUT
Set the tags for a Deployment
/deployments/{deployment_id}/tags -
POST
Upgrade a Deployment to a new Elastic Stack version
/deployments/{deployment_id}/upgrade -
GET
Get Deployment upgrade assistant status
/deployments/{deployment_id}/upgrade_assistant/status -
POST
Restores a shutdown resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore -
GET
Get plan activity
/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id} -
POST
Capture diagnostics for an Elasticsearch or Kibana resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture -
POST
Start all instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start -
POST
Stop all instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop -
POST
Start maintenance mode (all instances)
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start -
POST
Stop maintenance mode (all instances)
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop -
PUT
Set size overrides
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides -
POST
Start instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start -
POST
Stop instances
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop -
POST
Start maintenance mode
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start -
POST
Stop maintenance mode
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop -
PUT
Set size overrides
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides -
POST
Capture a new on-demand heap dump for the given instance
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture -
GET
Download the given instance's heap dump
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download -
POST
Capture a new thread dump for the given instance
/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture -
POST
Set a Deployment's resource metadata
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw -
PATCH
Patch a Deployment's resource metadata
/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw -
DELETE
Cancel resource pending plan
/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending -
GET
Proxy HTTP GET request
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} -
POST
Proxy HTTP POST request
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} -
PUT
Proxy HTTP PUT request
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} -
DELETE
Proxy HTTP DELETE request
/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} -
GET
Get the user settings of a Deployment resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings -
PUT
Update user settings for a deployment resource
/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings -
DELETE
Delete Stateless Resource from Deployment
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id} -
POST
Restart Deployment Stateless Resource
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart -
POST
Shutdown Deployment Stateless Resource
/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
Deployments - Extensions 6
-
GET
List Extensions
/deployments/extensions -
POST
Create an extension
/deployments/extensions -
GET
Get Extension
/deployments/extensions/{extension_id} -
POST
Update Extension
/deployments/extensions/{extension_id} -
PUT
Uploads the Extension
/deployments/extensions/{extension_id} -
DELETE
Delete Extension
/deployments/extensions/{extension_id}
Deployments - Templates 5
-
GET
Get deployment templates
/deployments/templates -
POST
Create deployment template
/deployments/templates -
GET
Get deployment template
/deployments/templates/{template_id} -
PUT
Set deployment template
/deployments/templates/{template_id} -
DELETE
Delete deployment template
/deployments/templates/{template_id}
Deployments - Traffic filters 12
-
GET
Get associated rulesets
/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets -
GET
List traffic filter claimed link id
/deployments/traffic-filter/link-ids -
POST
Claim a link id
/deployments/traffic-filter/link-ids/_claim -
POST
Unclaims a link id
/deployments/traffic-filter/link-ids/_unclaim -
GET
List traffic filter rulesets
/deployments/traffic-filter/rulesets -
POST
Create a ruleset
/deployments/traffic-filter/rulesets -
GET
Retrieves the ruleset by ID.
/deployments/traffic-filter/rulesets/{ruleset_id} -
PUT
Updates a ruleset
/deployments/traffic-filter/rulesets/{ruleset_id} -
DELETE
Delete a ruleset
/deployments/traffic-filter/rulesets/{ruleset_id} -
GET
Get associated deployments
/deployments/traffic-filter/rulesets/{ruleset_id}/associations -
POST
Create ruleset association
/deployments/traffic-filter/rulesets/{ruleset_id}/associations -
DELETE
Delete ruleset association
/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Networking - Deployment Domain Names 4
-
GET
Get default Deployment Domain Name
/platform/configuration/networking/deployment_domain_name -
PUT
Set default Deployment Domain Name
/platform/configuration/networking/deployment_domain_name -
GET
Get Deployment Domain Name for a resource kind
/platform/configuration/networking/deployment_domain_name/{resource_kind} -
PUT
Set Deployment Domain Name for a resource kind.
/platform/configuration/networking/deployment_domain_name/{resource_kind}
Organizations 23
-
GET
List organizations
/organizations -
GET
Get organization invitation
/organizations/invitations/{invitation_token} -
GET
Fetch organization information
/organizations/{organization_id} -
PUT
Update organization
/organizations/{organization_id} -
GET
Get domain claims
/organizations/{organization_id}/domains -
DELETE
Delete domain claim
/organizations/{organization_id}/domains -
POST
Generate verification code
/organizations/{organization_id}/domains/_generate_verification_code -
POST
Verify domain claim
/organizations/{organization_id}/domains/_verify -
GET
Get organization IdP
/organizations/{organization_id}/idp -
PUT
Setup organization IdP
/organizations/{organization_id}/idp -
DELETE
Tear down organization IdP
/organizations/{organization_id}/idp -
GET
Get organization service provider SAML2 metadata.xml for configuring the identity provider
/organizations/{organization_id}/idp/metadata.xml -
GET
List organization invitations
/organizations/{organization_id}/invitations -
POST
Create organization invitations
/organizations/{organization_id}/invitations -
DELETE
Delete organization invitations
/organizations/{organization_id}/invitations/{invitation_tokens} -
GET
List organization members
/organizations/{organization_id}/members -
DELETE
Delete organization memberships
/organizations/{organization_id}/members/{user_ids} -
GET
Get role mappings
/organizations/{organization_id}/role_mappings -
POST
Adds role mapping
/organizations/{organization_id}/role_mappings -
PUT
Updates role mappings
/organizations/{organization_id}/role_mappings -
DELETE
Delete role mappings
/organizations/{organization_id}/role_mappings -
DELETE
Delete role mapping
/organizations/{organization_id}/role_mappings/{role_names} -
PUT
Update role mapping
/organizations/{organization_id}/role_mappings/{role_name}
Platform 5
-
GET
Get platform info
/platform -
GET
List extra certificates
/platform/configuration/security/extra_certs -
GET
Read extra certificate
/platform/configuration/security/extra_certs/{cert_id} -
PUT
Update extra certificate
/platform/configuration/security/extra_certs/{cert_id} -
DELETE
Delete extra certificate
/platform/configuration/security/extra_certs/{cert_id}
Platform - Configuration - Instances - CRUD 5
-
GET
Get instance configurations
/platform/configuration/instances -
POST
Create instance configuration
/platform/configuration/instances -
GET
Get instance configuration
/platform/configuration/instances/{id} -
PUT
Set instance configuration
/platform/configuration/instances/{id} -
DELETE
Delete a instance configuration
/platform/configuration/instances/{id}
Platform - Configuration - Security 22
-
GET
Get current security deployment
/platform/configuration/security/deployment -
POST
Create security deployment
/platform/configuration/security/deployment -
PUT
Update security deployment
/platform/configuration/security/deployment -
GET
Get enrollment tokens
/platform/configuration/security/enrollment-tokens -
POST
Create enrollment token
/platform/configuration/security/enrollment-tokens -
DELETE
Delete enrollment token
/platform/configuration/security/enrollment-tokens/{token} -
GET
List security realm configurations
/platform/configuration/security/realms -
POST
Reorder security realms
/platform/configuration/security/realms/_reorder -
POST
Create Active Directory configuration
/platform/configuration/security/realms/active-directory -
GET
Get Active Directory configuration
/platform/configuration/security/realms/active-directory/{realm_id} -
PUT
Update Active Directory configuration
/platform/configuration/security/realms/active-directory/{realm_id} -
DELETE
Delete Active Directory configuration
/platform/configuration/security/realms/active-directory/{realm_id} -
POST
Create LDAP configuration
/platform/configuration/security/realms/ldap -
GET
Get LDAP configuration
/platform/configuration/security/realms/ldap/{realm_id} -
PUT
Update LDAP configuration
/platform/configuration/security/realms/ldap/{realm_id} -
DELETE
Delete LDAP configuration
/platform/configuration/security/realms/ldap/{realm_id} -
POST
Create SAML configuration
/platform/configuration/security/realms/saml -
GET
Get SAML configuration
/platform/configuration/security/realms/saml/{realm_id} -
PUT
Update SAML configuration
/platform/configuration/security/realms/saml/{realm_id} -
DELETE
Delete SAML configuration
/platform/configuration/security/realms/saml/{realm_id} -
GET
Get TLS certificate
/platform/configuration/security/tls/{service_name} -
POST
Set TLS certificate
/platform/configuration/security/tls/{service_name}
Platform - Configuration - Trust relationships 5
-
GET
List trust relationships
/platform/configuration/trust-relationships -
POST
Create trust relationship
/platform/configuration/trust-relationships -
GET
Get trust relationship
/platform/configuration/trust-relationships/{trust_relationship_id} -
PUT
Update trust relationship
/platform/configuration/trust-relationships/{trust_relationship_id} -
DELETE
Delete trust relationship
/platform/configuration/trust-relationships/{trust_relationship_id}
Platform - Infrastructure 83
-
GET
Get API base Url
/platform/configuration/api_base_url -
PUT
Set API base Url
/platform/configuration/api_base_url -
GET
List Config Store Option
/platform/configuration/store -
GET
Find Config Store Option by name
/platform/configuration/store/{config_option_id} -
POST
Create Config Store Option
/platform/configuration/store/{config_option_id} -
PUT
Update Config Store Option
/platform/configuration/store/{config_option_id} -
DELETE
Delete Config Store Option by name
/platform/configuration/store/{config_option_id} -
GET
Get adminconsoles
/platform/infrastructure/adminconsoles -
POST
Reindex region indices
/platform/infrastructure/adminconsoles/_reindex -
GET
Get adminconsole logging settings
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings -
PUT
Set adminconsole logging settings
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings -
PATCH
Update adminconsole logging settings
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings -
DELETE
Delete adminconsole logging settings
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings -
GET
Get allocators
/platform/infrastructure/allocators -
POST
Resynchronize allocators
/platform/infrastructure/allocators/_resync -
POST
Search allocators
/platform/infrastructure/allocators/_search -
GET
Get allocator
/platform/infrastructure/allocators/{allocator_id} -
DELETE
Delete allocator
/platform/infrastructure/allocators/{allocator_id} -
POST
Resynchronize allocator
/platform/infrastructure/allocators/{allocator_id}/_resync -
POST
Move clusters
/platform/infrastructure/allocators/{allocator_id}/clusters/_move -
POST
Move clusters by type
/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move -
GET
Get allocator logging settings
/platform/infrastructure/allocators/{allocator_id}/logging_settings -
PUT
Set allocator logging settings
/platform/infrastructure/allocators/{allocator_id}/logging_settings -
PATCH
Update allocator logging settings
/platform/infrastructure/allocators/{allocator_id}/logging_settings -
DELETE
Delete allocator logging settings
/platform/infrastructure/allocators/{allocator_id}/logging_settings -
POST
Start maintenance mode
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start -
POST
Stop maintenance mode
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_stop -
GET
Get allocator metadata
/platform/infrastructure/allocators/{allocator_id}/metadata -
PUT
Set allocator metadata
/platform/infrastructure/allocators/{allocator_id}/metadata -
PUT
Set allocator metadata item
/platform/infrastructure/allocators/{allocator_id}/metadata/{key} -
DELETE
Delete allocator metadata item
/platform/infrastructure/allocators/{allocator_id}/metadata/{key} -
GET
Get allocator settings
/platform/infrastructure/allocators/{allocator_id}/settings -
PUT
Set allocator settings
/platform/infrastructure/allocators/{allocator_id}/settings -
PATCH
Update allocator settings
/platform/infrastructure/allocators/{allocator_id}/settings -
GET
List roles
/platform/infrastructure/blueprinter/roles -
POST
Create a role
/platform/infrastructure/blueprinter/roles -
GET
Get role
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} -
PUT
Update role
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} -
DELETE
Delete role
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} -
PUT
Set blessings
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings -
PUT
Add Blessing
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id} -
GET
Get constructors
/platform/infrastructure/constructors -
POST
Resynchronize constructors
/platform/infrastructure/constructors/_resync -
GET
Get constructor
/platform/infrastructure/constructors/{constructor_id} -
POST
Resynchronize constructor
/platform/infrastructure/constructors/{constructor_id}/_resync -
GET
Get constructor logging settings
/platform/infrastructure/constructors/{constructor_id}/logging_settings -
PUT
Set constructor logging settings
/platform/infrastructure/constructors/{constructor_id}/logging_settings -
PATCH
Update constructor logging settings
/platform/infrastructure/constructors/{constructor_id}/logging_settings -
DELETE
Delete constructor logging settings
/platform/infrastructure/constructors/{constructor_id}/logging_settings -
POST
Start maintenance mode
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start -
POST
Stop maintenance mode
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_stop -
GET
Get coordinators
/platform/infrastructure/coordinators -
GET
Get coordinator candidates
/platform/infrastructure/coordinators/candidates -
GET
Get a coordinator candidate
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id} -
DELETE
Delete coordinator candidate
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id} -
POST
Promote a coordinator candidate
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}/_promote -
GET
Get a coordinator
/platform/infrastructure/coordinators/{coordinator_id} -
POST
Demote a coordinator
/platform/infrastructure/coordinators/{coordinator_id}/_demote -
GET
Get proxies
/platform/infrastructure/proxies -
POST
Create filtered group of proxies
/platform/infrastructure/proxies/filtered-groups -
GET
Get filtered group of proxies
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} -
PUT
Update filtered group of proxies
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} -
DELETE
Delete filtered group of proxies
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} -
GET
Get health for a filtered group of proxies
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health -
GET
Get proxy health
/platform/infrastructure/proxies/health -
GET
Get proxies settings
/platform/infrastructure/proxies/settings -
PUT
Set proxy settings
/platform/infrastructure/proxies/settings -
PATCH
Update proxy settings
/platform/infrastructure/proxies/settings -
GET
Get proxy
/platform/infrastructure/proxies/{proxy_id} -
GET
Get runners
/platform/infrastructure/runners -
POST
Resynchronize runners
/platform/infrastructure/runners/_resync -
POST
Search runners
/platform/infrastructure/runners/_search -
GET
Get runner
/platform/infrastructure/runners/{runner_id} -
DELETE
Delete runner
/platform/infrastructure/runners/{runner_id} -
POST
Resynchronize runner
/platform/infrastructure/runners/{runner_id}/_resync -
GET
Get runner logging settings
/platform/infrastructure/runners/{runner_id}/logging_settings -
PUT
Set runner logging settings
/platform/infrastructure/runners/{runner_id}/logging_settings -
PATCH
Update runner logging settings
/platform/infrastructure/runners/{runner_id}/logging_settings -
DELETE
Delete runner logging settings
/platform/infrastructure/runners/{runner_id}/logging_settings -
PUT
Set runner roles
/platform/infrastructure/runners/{runner_id}/roles -
GET
Get license
/platform/license -
PUT
Add or update license
/platform/license -
DELETE
Delete license
/platform/license
Platform - Repository - CRUD 4
-
GET
Get snapshot repositories
/platform/configuration/snapshots/repositories -
GET
Get snapshot repository
/platform/configuration/snapshots/repositories/{repository_name} -
PUT
Set snapshot repository
/platform/configuration/snapshots/repositories/{repository_name} -
DELETE
Delete snapshot repository
/platform/configuration/snapshots/repositories/{repository_name}
Stack - Versions - CRUD 6
-
GET
DEPRECATED: Scheduled to be removed in a future release.
Get instance types
/stack/instance-types -
GET
Get stack versions
/stack/versions -
POST
Upload stack pack
/stack/versions -
GET
Get stack version
/stack/versions/{version} -
PUT
Update stack version
/stack/versions/{version} -
DELETE
Delete stack version
/stack/versions/{version}