API Reference

Update sandbox group credential

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

Update a credential. Developers can change injection, methods, paths,
and enabled. Changing domain or value requires an admin.

Omitted top-level fields keep their current values. Providing injection
replaces the entire object. Its template defaults to ${SECRET} when
omitted. An empty methods or paths list removes that filter. Providing
value creates a new version.
The combined serialized size of current credential settings and secret
values in the group must remain within 200 KiB (204800 bytes).

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.

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

The ID of the credential. Must be unique within this sandbox group.

Body Params

The credential settings to update. Omitted top-level fields keep their current
values. Providing injection replaces the entire object. Its template
defaults to ${SECRET} when omitted. Empty methods or paths lists remove
those filters. Developers can update injection, methods, paths, and
enabled. Changing domain or value requires an admin.

Changes to routing, injection, or enabled state create a new version. Setting
value creates a new version even if the secret value is unchanged. The
credential ID cannot be changed.

string
length ≤ 5120

The replacement secret value, up to 5 KiB (5120 UTF-8 bytes). Requires an admin. Omit to preserve the current value.

string

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. Omit to preserve the current hostname.

boolean

Whether this credential is enabled for injection. Omit to preserve the current setting.

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.
An empty list matches any method. Omit to preserve the current filter.

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.
An empty list matches any path. Omit to preserve the current filter.

paths
injection
object

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