Api reference
Parameters
Get Parameter Status
Path Parameters
org_id*Org Id
app_id*App Id
Query Parameters
workspace_id*Workspace Id
namespace_id?string|null
Header Parameters
authorization?string|null
Response Body
application/json
application/json
curl -X GET "https://loading/v1/orgs/string/apps/string/parameters/status?workspace_id=string"{
"app_id": "string",
"workspace_id": "string",
"namespace_id": "string",
"parameters": [
{
"name": "string",
"type": "secret",
"resolution_mode": "fixed",
"description": "string",
"required": true,
"default_value": "string",
"is_set": false,
"set_at": "string",
"set_by": "string",
"secret_status": "string"
}
],
"total": 0,
"configured": 0,
"missing_required": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Delete Parameter Value
Path Parameters
org_id*Org Id
app_id*App Id
parameter_name*Parameter Name
Query Parameters
workspace_id*Workspace Id
namespace_id?string|null
environment_id?|
Delete an environment-specific override
Header Parameters
authorization?string|null
Response Body
application/json
application/json
curl -X DELETE "https://loading/v1/orgs/string/apps/string/parameters/string/value?workspace_id=string"null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Set Parameter Value
Path Parameters
org_id*Org Id
app_id*App Id
parameter_name*Parameter Name
Query Parameters
workspace_id*Workspace Id
namespace_id?string|null
environment_id?|
Set an environment-specific override
Header Parameters
authorization?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
value*Value
Value to set. String for config, JSON object for secret.
Response Body
application/json
application/json
curl -X PUT "https://loading/v1/orgs/string/apps/string/parameters/string/value?workspace_id=string" \ -H "Content-Type: application/json" \ -d '{ "value": null }'null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}