Skip to content
Runta Runta
Start free trial

Store or replace a runtime-scoped secret stub

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
runtime_id
required

Runtime UUID or display name.

string

Runtime UUID or display name.

Request Body required

Section titled “Request Body required ”

Secret stub set request.

Media type application/json

Secret stub creation request.

object
host
required

Host pattern.

string
config
required
Any of:

Stub 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
stub_value
required

Secret stub value ID or display name.

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response envelope.

Media type application/json

Response envelope.

object
data
required

Secret stub response object.

object
host_pattern
required

Host pattern that must match before injection.

string
id
required

Stable stub UUID.

string
path_pattern
required

Path pattern that must match before injection.

string
runtime_display_name
required

Runtime display name that owns the stub.

string
stub_config_json
required

Stub config JSON string.

string
stub_value_display_name
required

Stored stub value display name.

string
Example generated
{
  "data": {
    "host_pattern": "example",
    "id": "example",
    "path_pattern": "example",
    "runtime_display_name": "example",
    "stub_config_json": "example",
    "stub_value_display_name": "example"
  }
}

401

Section titled “401 ”

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"
  }
}

403

Section titled “403 ”

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"
  }
}

404

Section titled “404 ”

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"
  }
}

409

Section titled “409 ”

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"
  }
}

422

Section titled “422 ”

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"
  }
}

429

Section titled “429 ”

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"
  }
}

503

Section titled “503 ”

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"
  }
}

504

Section titled “504 ”

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"
  }
}

default

Section titled “default ”

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"
  }
}