List trust relationships

GET /platform/configuration/trust-relationships

List trust relationships.

Query parameters

  • Whether to include the public CA certificates in the response.

    Default value is false.

  • filter string

    Which trust relationships to return in the response. Defaults to all

    Values are all, local, or non-local. Default value is all.

Responses

  • The list of trust relationships.

    Hide response attribute Show response attribute object
    • trust_relationships array[object] Required

      The trust relationships

      Hide trust_relationships attributes Show trust_relationships attributes object
      • id string Required

        The id of the trust relationship

      • name string Required

        The name of the trust relationship

      • trust_by_default boolean Required

        If this relationship is trusted by default by all deployments in the current environment.

      • account_ids array[string]

        The ID of the accounts trusted by this relationship.

      • The public CA certificate of the environment to trust

      • local boolean Required

        If this is the trust relationship for the local environment

      • The installation ID of the environment to trust

      • last_modified string(date-time) Required

        The most recent time the trust relationship was changed (ISO format in UTC)

  • You are not authorized to perform this action.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/configuration/trust-relationships
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/trust-relationships
Response examples (200)
{
  "trust_relationships": [
    {
      "id": "string",
      "name": "string",
      "trust_by_default": true,
      "account_ids": [
        "string"
      ],
      "public_ca_cert": "string",
      "local": true,
      "installation_id": "string",
      "last_modified": "2024-05-04T09:42:00+00:00"
    }
  ]
}
Response examples (401)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}