GuidesAPI Reference
API Reference

Get App Code

get deprecated
https://Use API Lookup for a base URL/apps//appCode

Get the App Code configured for an application. App Codes are deprecated and in a read-only state. An App can either have 0 or 1 App Code, depending whether they have appCodeEnabled or not. To retrieve the appCode via this endpoint the App needs to have appCodeEnabled=true and appCodeVisible=true.


An App Code can be used with certain classic HLS Services that still support app_id and app_code values in the query string for authentication.


Access Control:

  • The calling principal must have "manage" 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.

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

404
  • E202404 - No app exists with the given id.
409
  • E202102 - The specified App does not support App Codes.
429
  • E202429 - Request blocked because of too many requests made. Wait for a while before making a new request.

Updated last month

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated last month