GuidesAPI Reference
API Reference

Add a Trusted Domain to an application

Add a Trusted Domain to an application. A maximum of 3000 Trusted Domains per application are allowed.


Access Control:

  • The calling principal must have "manage" or "write" action permission for the resource "{app}" in the "account" service.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN identifying the application. Must be URL-encoded, if reserved characters ":/?#[]@!$&'()*+,;=" are used. see https://tools.ietf.org/html/rfc3986#section-2.2.

string
required

URI for a Trusted Domain. A Trusted Domain must conform to the follow validation rules:

  • entries must include a domain name (e.g. example.com)
  • no longer than 2048 characters
  • use correct URI format
  • IPv4 addresses are permitted (e.g. 192.168.1.1 or 192.168.1.1:1080)
  • protocol is optional (e.g. https://example.com)
  • port is optional (e.g. example.com:1080)
Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

Responses

400
  • 400288 - Invalid app HRN.
  • 400203 - Invalid Trusted Domain URI.
  • 400368 - Trusted Domain URI too long.
404
  • 404660 - No app exists with the given HRN.
422
  • 422000 - Maximum number of Trusted Domains reached
429
  • 429003 - Request blocked because of too many Trusted Domains being added or deleted. Wait for a while before retrying the request.
Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*