Get trust relationship

edit

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

Request

edit

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

Path parameters

edit
Name Type Required Description

trust_relationship_id

string

Y

Identifier for the trust relationship

Query parameters

edit
Name Type Required Description

include_certificate

boolean; default: false

N

Whether to include the public CA certificates in the response.

Responses

edit
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 example

edit
curl -XGET https://{{hostname}}/api/v1/platform/configuration/trust-relationships/{trust_relationship_id} \
-H "Authorization: ApiKey $ECE_API_KEY"