GuidesAPI Reference
API Reference

Update Secret

patch
https://Use API Lookup for a base URL/secrets/

Updates a Secret.


Access Control:

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

HRN for a Secret.

Body Params
string

Web-safe-base64-encoded secret file contents.

string
enum

"aws" or "custom". For "aws", the platform will place the file in ~/.aws/. For "custom", the platform will place the file in ~/.here/.

Allowed:
string

A relative filename for the platform to use to write the secret in plaintext on the filesystem. The file will be placed in the directory as specified by the 'type' property. Defaults to "credentials".

string

a descriptive name for the secret

boolean

true for enabled, false for disabled. An enabled=false (disabled) secret is not delivered to Platform Runtimes.

string

Date-time formatted time this Secret expires. A null value or missing property means there is no end time at which the Secret expires. This property has no effect if enabled=false. An expired secret is not delivered to Platform Runtimes.

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

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