ApiTargetEndpoint

ApiTargetEndpoint contains API endpoint patterns that are matched against request URLs.

hoststringrequired

Host is matched against the host part in the request URL. Port may be omitted if it matches the default port 80 for http or 443 for https. Matching is case-insensitive exact match.

protocolsstring[]required

Protocols are matched against request URL scheme. Accepted values are "http", "https" and "*" (for http or https).

Possible values: [http, https, *]

methodsstring[]required

Methods are matched against request HTTP method. Accepted values are "GET","PUT","POST","DELETE","HEAD","PATCH","OPTIONS","TRACE" and "*".

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

pathsstring[]required

Paths are matched against request URL path. Supported wildcards are "*" matches one path segment, "**" matches rest of the path.

allow_unauthenticatedbooleanrequired

If true, unauthenticated requests matching this endpoint are allowed

nat_target_hoststring

Optional NAT target host (used when forwarding requests over an extender)

ApiTargetEndpoint

{
  "host": "string",
  "protocols": [
    "http"
  ],
  "methods": [
    "GET"
  ],
  "paths": [
    "string"
  ],
  "allow_unauthenticated": true,
  "nat_target_host": "string"
}