Docs
Elasticsearch Service Documentation » RESTful API » API reference documentation » Platform - Configuration - Trust relationships
« Deployments - Traffic Filter - CRUD Stack - Versions - CRUD »

Platform - Configuration - Trust relationshipsedit

List trust relationshipsedit

List trust relationships.

Requestedit

GET /api/v1/platform/configuration/trust-relationships

Query parametersedit

Name Type Required Description

include_certificate

boolean; default: false

N

Whether to include the public CA certificates in the response.

Responsesedit

200

(TrustRelationshipsListResponse) The list of trust relationships.

401

(BasicFailedReply) You are not authorized to perform this action.

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/platform/configuration/trust-relationships \
-H "Authorization: ApiKey $EC_API_KEY"

Create trust relationshipedit

Creates a trust relationship.

Requestedit

POST /api/v1/platform/configuration/trust-relationships

Request bodyedit

(TrustRelationshipCreateRequest) (required) The trust relationship definition

Responsesedit

201

(TrustRelationshipCreateResponse) The request was valid and a new trust relationship was created

Headers

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)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
400

(BasicFailedReply) The trust relationship request had errors.

401

(BasicFailedReply) You are not authorized to perform this action.

Request exampleedit

curl -XPOST https://api.elastic-cloud.com/api/v1/platform/configuration/trust-relationships \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "account_ids" : [
      {
         "value" : "string"
      }
   ],
   "installation_id" : "string",
   "name" : "string",
   "public_ca_cert" : "string",
   "trust_by_default" : true
}
'

Delete trust relationshipedit

Deletes a trust relationship.

Requestedit

DELETE /api/v1/platform/configuration/trust-relationships/{trust_relationship_id}

Path parametersedit

Name Type Required Description

trust_relationship_id

string

Y

Identifier for the trust relationship

Query parametersedit

Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Responsesedit

200

(EmptyResponse) The request was valid and the trust relationship was deleted.

401

(BasicFailedReply) You are not authorized to perform this action.

404

(BasicFailedReply) The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)

Headers

x-cloud-error-codes (string; allowed values: [trust_relationships.not_found])
The error codes associated with the response

Request exampleedit

curl -XDELETE https://api.elastic-cloud.com/api/v1/platform/configuration/trust-relationships/{trust_relationship_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get trust relationshipedit

Retrieves information about a trust relationship. local can be used as the ID to obtain the local trust relationship.

Requestedit

GET /api/v1/platform/configuration/trust-relationships/{trust_relationship_id}

Path parametersedit

Name Type Required Description

trust_relationship_id

string

Y

Identifier for the trust relationship

Query parametersedit

Name Type Required Description

include_certificate

boolean; default: false

N

Whether to include the public CA certificates in the response.

Responsesedit

200

(TrustRelationshipGetResponse) The trust relationship info response

Headers

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)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
401

(BasicFailedReply) You are not authorized to perform this action.

404

(BasicFailedReply) The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)

Headers

x-cloud-error-codes (string; allowed values: [trust_relationships.not_found])
The error codes associated with the response

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/platform/configuration/trust-relationships/{trust_relationship_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Update trust relationshipedit

Updates a trust relationship.

Requestedit

PUT /api/v1/platform/configuration/trust-relationships/{trust_relationship_id}

Path parametersedit

Name Type Required Description

trust_relationship_id

string

Y

Identifier for the trust relationship

Request bodyedit

(TrustRelationshipUpdateRequest) (required) The trust relationship definition

Responsesedit

200

(TrustRelationshipUpdateResponse) The request was valid and the trust relationship was updated.

Headers

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)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
400

(BasicFailedReply) The trust relationship request had errors.

401

(BasicFailedReply) You are not authorized to perform this action.

404

(BasicFailedReply) The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)

Headers

x-cloud-error-codes (string; allowed values: [trust_relationships.not_found])
The error codes associated with the response

Request exampleedit

curl -XPUT https://api.elastic-cloud.com/api/v1/platform/configuration/trust-relationships/{trust_relationship_id} \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "account_ids" : [
      {
         "value" : "string"
      }
   ],
   "installation_id" : "string",
   "name" : "string",
   "public_ca_cert" : "string",
   "trust_by_default" : true
}
'
« Deployments - Traffic Filter - CRUD Stack - Versions - CRUD »