Skip to main content
GET
/
v1
/
secrets
/
{name}
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

const secretView = await client.secrets.retrieve('name');

console.log(secretView.id);
{
  "id": "<string>",
  "name": "<string>",
  "create_time_ms": 123,
  "update_time_ms": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
name
string
required

The name of the Secret to retrieve.

Response

Successfully retrieved the Secret. Value is omitted for security.

A Secret represents a key-value pair that can be securely stored and used in Devboxes as environment variables.

​
id
string
required

The unique identifier of the Secret.

​
name
string
required

The globally unique name of the Secret. Used as the environment variable name in Devboxes.

​
create_time_ms
integer<int64>
required

Creation time of the Secret (Unix timestamp in milliseconds).

​
update_time_ms
integer<int64>
required

Last update time of the Secret (Unix timestamp in milliseconds).