API Reference

Create sandbox group credential

post
https://api.render.com/v1/sandbox-groups//credentials

Configure a credential for injection into matching outbound HTTPS requests
from sandboxes in this group. Requires an admin. You assign the credential ID.

Each group supports up to 25 credentials. Current credential settings and
secret values have a combined serialized size limit of 200 KiB (204800
bytes). Render retains the current configuration and three distinct prior
configurations per credential, with a total storage limit of 1 MiB including
version metadata.

The response confirms the configuration was saved. It does not confirm that
credential injection is active for a particular sandbox.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^sbg-[0-9a-v]{20}$

The ID of the sandbox group.

Body Params

The credential configuration to create, including request matching and injection settings.

string
required
length ≥ 1
^[A-Za-z0-9._~-]+$

The case-sensitive ID you assign to the credential, unique within its sandbox group.
Use only letters, numbers, periods, underscores, tildes, and hyphens. The names
. and .. and IDs starting with rnd- are reserved.

string
required

The destination hostname to match for credential injection. Must
be a public DNS hostname. Render normalizes it to lowercase and matches it
exactly. IP addresses, ports, wildcards, and local or internal hostnames are
not supported.

string
required
length ≤ 5120

The secret value to store, up to 5 KiB (5120 UTF-8 bytes).

boolean
Defaults to true

Whether this credential is enabled for injection. Defaults to true.

methods
array of strings

The HTTP methods to match for credential injection.
Supported methods are GET, HEAD, POST, PUT, PATCH, DELETE, and OPTIONS,
normalized to uppercase.
Omit or provide an empty list to match any method.

methods
paths
array of strings

The request path patterns to match for credential injection. Each
pattern must match the entire absolute path. Use * for one nonempty path segment or
** for one or more segments. Wildcards must occupy whole segments. For
example, /a/* matches /a/b, and /a/** also matches /a/b/c. Neither
matches /a. Patterns do not support query strings, fragments, or escaping.
Request query strings do not affect matching.
Omit or provide an empty list to match any path.

paths
injection
object
required

Settings for injecting the secret value into matching outbound HTTPS requests.

Responses

Updated about 3 hours ago

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

Updated about 3 hours ago