Skip to content

Create a runtime-scoped secret injection rule

POST
/v1/runtimes/{runtime_id}/secret-injection-rules
curl --request POST \
--url http://127.0.0.1:8080/v1/runtimes/example/secret-injection-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "host": "example", "injection": { "headerName": "example", "paramFormat": "example", "paramName": "example", "value": "example", "valueFormat": "example" }, "path": "example", "secret": "example" }'
runtime_id
required

Runtime UUID or display name.

string

Runtime UUID or display name.

Secret injection rule creation request.

Media type application/json

Secret injection rule creation request.

object
host
required

Host pattern.

string
injection
required
Any of:

Injection config JSON value.

object
headerName
required

Request header name to set.

string
>= 1 characters
paramFormat

Query parameter value template. ${credential} and {value} are replaced with the secret value.

string
paramName

Query parameter name to set.

string
>= 1 characters
value

Shared value template used when valueFormat or paramFormat is absent.

string
valueFormat

Header value template. ${credential} and {value} are replaced with the secret value.

string
key
additional properties
any
path

Optional path pattern.

string
nullable
secret
required

Secret ID or display name.

string
Example generated
{
"host": "example",
"injection": {
"headerName": "example",
"paramFormat": "example",
"paramName": "example",
"value": "example",
"valueFormat": "example"
},
"path": "example",
"secret": "example"
}

Response envelope.

Media type application/json

Response envelope.

object
data
required

Secret injection rule response object.

object
credential_display_name
required

Stored credential display name.

string
host_pattern
required

Host pattern that must match before injection.

string
id
required

Stable rule UUID.

string
injection_config_json
required

Injection config JSON string.

string
path_pattern
required

Path pattern that must match before injection.

string
runtime_display_name
required

Runtime display name that owns the rule.

string
Example generated
{
"data": {
"credential_display_name": "example",
"host_pattern": "example",
"id": "example",
"injection_config_json": "example",
"path_pattern": "example",
"runtime_display_name": "example"
}
}

Missing, malformed, or rejected bearer token

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

The bearer token is not allowed to perform this action

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

The requested resource was not found

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

The request conflicts with current resource state

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

Validation or application error

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

Rate limit exceeded

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

Upstream service is unavailable

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

Upstream request timed out

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}

Error response

Media type application/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
Example
{
"error": {
"code": "already_exists"
}
}