Update API Key

patch

https://Use API Lookup for a base URL/apps/{app}/apiKeys/{apiKey}

Updates API key of the application.

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

app

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.

apiKey

string

required

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

Body Params

name

string

Creator-defined name or short description for the API key.

expiresAt

int64

Defaults to -1

Timestamp (milliseconds since the Unix epoch) of when the API key will expire. If expiresAt is not provided on creation, it will default to '-1', i.e. API key does NOT expire

Headers

X-Correlation-ID

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.

X-Request-ID

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

401

401300 - Access is denied due to invalid credentials.

404

404660 - No app exists with the given id.
404666 - The API key does not exist.

429

429003 - Request blocked because of too many requests made. Wait for a while before making a new request.

200OK