target_api_data

target API data snapshot

idstring

namestring

commentstring

tagsstring[]

access_group_idstring

roles object[]

Array [

idstring<uuid>

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059

namestring

Example: example-admins

deletedboolean

]

authorized_endpoints object[]

Array [

hoststring

protocolsstring[]

methodsstring[]

Possible values: [GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, TRACE, *]

pathsstring[]

allow_unauthenticatedboolean

nat_target_hoststring

optional api target host address

]

unauthorized_endpoints object[]

Array [

hoststring

protocolsstring[]

methodsstring[]

Possible values: [GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, TRACE, *]

pathsstring[]

allow_unauthenticatedboolean

nat_target_hoststring

optional api target host address

]

tls_trust_anchorsstring

tls_insecure_skip_verifyboolean

target_credential object

credentials used for authentication to the API target

typestring

credential type

Possible values: [basicauth, token, certificate, ephemeral-certificate]

ephemeral_certificate_subjectstring

certificate subject name pattern for ephemeral-certificate type

ephemeral_certificate_sanstring

certificate subject alternative name for ephemeral-certificate type

ephemeral_certificate_templatestring

certificate template for ephemeral-certificate type

disabledstring

Possible values: [NOT_DISABLED, BY_ADMIN, BY_LICENSE]

audit_enabledboolean

createdstring

authorstring

updatedstring

updated_bystring

target_api_data

{
  "id": "string",
  "name": "string",
  "comment": "string",
  "tags": [
    "string"
  ],
  "access_group_id": "string",
  "roles": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "name": "example-admins",
      "deleted": true
    }
  ],
  "authorized_endpoints": [
    {
      "host": "string",
      "protocols": [
        "string"
      ],
      "methods": [
        "GET"
      ],
      "paths": [
        "string"
      ],
      "allow_unauthenticated": true,
      "nat_target_host": "string"
    }
  ],
  "unauthorized_endpoints": [
    {
      "host": "string",
      "protocols": [
        "string"
      ],
      "methods": [
        "GET"
      ],
      "paths": [
        "string"
      ],
      "allow_unauthenticated": true,
      "nat_target_host": "string"
    }
  ],
  "tls_trust_anchors": "string",
  "tls_insecure_skip_verify": true,
  "target_credential": {
    "type": "basicauth",
    "ephemeral_certificate_subject": "string",
    "ephemeral_certificate_san": "string",
    "ephemeral_certificate_template": "string"
  },
  "disabled": "NOT_DISABLED",
  "audit_enabled": true,
  "created": "string",
  "author": "string",
  "updated": "string",
  "updated_by": "string"
}