Get trusted environments
https://api.elastic-cloud.com/api/v1
- GET /trusted-environments
Returns the list of trusted environments for the organization. If no organization is passed in, the organization attached to the user is assumed.
Responses
Trusted environments for this organization
-
accountsAccountTrustRelationship -
The list of trust relationships with different accounts
-
account_idstringrequired -
the ID of the Account
-
namestring -
A human readable name of the trust relationship
-
trust_allbooleanrequired -
If true, all clusters in this account will by default be trusted and the
trust_allowlistis ignored. -
trust_allowliststring -
The list of clusters to trust. Only used when
trust_allis false. -
externalExternalTrustRelationship -
The list of trust relationships with external entities
-
trust_relationship_idstringrequired -
The ID of the external trust relationship
-
namestring -
The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.
-
trust_allbooleanrequired -
If true, all clusters in this external entity will be trusted and the
trust_allowlistis ignored. -
trust_allowliststring -
The list of clusters to trust. Only used when
trust_allis false. -
directDirectTrustRelationship -
The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.
-
uidstring -
Auto generated identifier for this trust, allows distinguishing between update vs remove and add.
-
namestringrequired -
a human readable name of the trust relationship
-
type -
The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.
-
Values:
ECEESSgenericproxy -
trust_allbooleanrequired -
If true, scope_id is required and the
trust_allowlistis ignored and all clusters matching the scope id will be trusted. -
trust_allowliststring -
The list of clusters with matching scope to trust. Only used when
trust_allis false. Providing one or more clusters makes scope_id mandatory. -
scope_idstring -
A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.
-
additional_node_namesstring -
A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.
-
certificatesTrustedCertificaterequired -
The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.
-
pemstringrequired -
The public ca certificate as string in PEM format.
-
metadataCertificateMetaData -
The certificate MetaData
-
fingerprintstringrequired -
The fingerprint of the certificate
-
valid_tostringrequired -
The expiry date of the certificate in UTC
-
valid_fromstringrequired -
The valid from date of the certificate in UTC
-
also_trusted_bystring -
Other deployments also trusting this certificate
Organization not found. (code: organization.not_found)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response