API ReferenceWritable configuration
Writable configuration
Lists the workspace-specific keys accepted by incident and service requests. These endpoints also identify the default status, severity, and service tier.
GET/api/v1/configuration/workflow-statusesList available workflow statuses
#Returns the workflow statuses that incident requests can use. The response lists statuses in workflow order. Exactly one status has is_default set to true. If a create-incident request omits status, the API uses that status.
- Operation ID
- listWorkflowStatuses
- Scope
- incidents:read
- Prerequisites
- None
- Retry guidance
- This operation is repeat-safe. Respect Retry-After and use bounded retries. Retry rules
Example request
Replace {company}, <token>, and any other placeholders with your values.
curl --request GET \
--url 'https://{company}.api.tellagen.com/api/v1/configuration/workflow-statuses' \
--header 'Authorization: Bearer <token>'Success: 200
Each entry contains a status key, label, display order, default flag, lifecycle flags, and color.
Success response JSON
{
"workflow_statuses": [
{
"key": "open",
"label": "Open",
"order": 0,
"is_default": true,
"is_terminal": false,
"is_escalation_threshold": true,
"color": "ember"
},
{
"key": "resolved",
"label": "Resolved",
"order": 1,
"is_default": false,
"is_terminal": true,
"is_escalation_threshold": false,
"color": "moss"
}
]
}Request and response contract
Response 200
Each entry contains a status key, label, display order, default flag, lifecycle flags, and color.
Always means present when the parent object exists. A present field can be null. Child fields apply to each array item.
| Field | Type | Returned | Description |
|---|---|---|---|
workflow_statuses | object[] | Always | The workflow statuses in configured workflow order. |
workflow_statuses[].key | string | Always | A workflow-status key accepted by incident requests. |
workflow_statuses[].label | string | Always | The status name shown to users. |
workflow_statuses[].order | integer | Always | The zero-based position of the status in the workflow. Minimum: 0. |
workflow_statuses[].is_default | boolean | Always | Identifies the default workflow status for new incidents. |
workflow_statuses[].is_terminal | boolean | Always | Indicates whether this status ends the active incident workflow. |
workflow_statuses[].is_escalation_threshold | boolean | Always | Indicates whether this status is the configured escalation threshold. |
workflow_statuses[].color | string | Always | The color token used to display the status. |
Errors and recovery (7)
Error responses (7)
- 400
- The API rejected the request because its syntax or one of its values is invalid.
- 401
- The request does not contain valid authentication.
- 403
- Authentication succeeded, but the caller lacks the required API scope or workspace permission.
- 404
- The requested resource does not exist or is not available to the caller.
- 409
- The request conflicts with the current resource state. idempotency_key_reused means that the key belongs to different request content. idempotency_in_progress means that an identical request is still in progress. idempotency_outcome_unknown means that an earlier request may have completed, but its result could not be stored and must not be retried automatically.
- 429
- The workspace exceeded an active request limit.
- 500
- An internal server error prevented completion of the request.
GET/api/v1/configuration/severitiesList available severities
#Returns the severity levels that incident requests can use. The response lists severities from the highest score threshold to the lowest. Exactly one severity has is_default set to true. If a create-incident request omits severity, the API uses that severity.
- Operation ID
- listSeverities
- Scope
- incidents:read
- Prerequisites
- None
- Retry guidance
- This operation is repeat-safe. Respect Retry-After and use bounded retries. Retry rules
Example request
Replace {company}, <token>, and any other placeholders with your values.
curl --request GET \
--url 'https://{company}.api.tellagen.com/api/v1/configuration/severities' \
--header 'Authorization: Bearer <token>'Success: 200
Each entry contains a severity key, label, display order, default flag, score threshold, description, and color.
Success response JSON
{
"severities": [
{
"key": "sev1",
"label": "SEV1",
"order": 0,
"is_default": false,
"min_score": 300,
"description": "Critical - complete outage",
"color": "ember"
},
{
"key": "sev2",
"label": "SEV2",
"order": 1,
"is_default": true,
"min_score": 150,
"description": "Major - degraded experience",
"color": "amber-500"
}
]
}Request and response contract
Response 200
Each entry contains a severity key, label, display order, default flag, score threshold, description, and color.
Always means present when the parent object exists. A present field can be null. Child fields apply to each array item.
| Field | Type | Returned | Description |
|---|---|---|---|
severities | object[] | Always | The severity levels from the highest score threshold to the lowest. |
severities[].key | string | Always | A severity key accepted by incident requests. |
severities[].label | string | Always | The severity name shown to users. |
severities[].order | integer | Always | The zero-based position of the severity in the response. Minimum: 0. |
severities[].is_default | boolean | Always | Identifies the default severity for new incidents. |
severities[].min_score | number | Always | The minimum calculated score for this severity. Minimum: 0. |
severities[].description | string | Always | The workspace description of this severity. |
severities[].color | string | Always | The color token used to display the severity. |
Errors and recovery (7)
Error responses (7)
- 400
- The API rejected the request because its syntax or one of its values is invalid.
- 401
- The request does not contain valid authentication.
- 403
- Authentication succeeded, but the caller lacks the required API scope or workspace permission.
- 404
- The requested resource does not exist or is not available to the caller.
- 409
- The request conflicts with the current resource state. idempotency_key_reused means that the key belongs to different request content. idempotency_in_progress means that an identical request is still in progress. idempotency_outcome_unknown means that an earlier request may have completed, but its result could not be stored and must not be retried automatically.
- 429
- The workspace exceeded an active request limit.
- 500
- An internal server error prevented completion of the request.
GET/api/v1/configuration/service-tiersList available service tiers
#Returns the service tiers that service requests can use. The response lists tiers in configured rank order. Exactly one tier has is_default set to true. If a create-service request omits tier, the API uses that tier.
- Operation ID
- listServiceTiers
- Scope
- services:read
- Prerequisites
- None
- Retry guidance
- This operation is repeat-safe. Respect Retry-After and use bounded retries. Retry rules
Example request
Replace {company}, <token>, and any other placeholders with your values.
curl --request GET \
--url 'https://{company}.api.tellagen.com/api/v1/configuration/service-tiers' \
--header 'Authorization: Bearer <token>'Success: 200
Each entry contains a tier key, label, display order, default flag, and description.
Success response JSON
{
"service_tiers": [
{
"key": "t0",
"label": "T0 - Mission Critical",
"order": 0,
"is_default": false,
"description": "Mission critical"
},
{
"key": "t2",
"label": "T2 - Important",
"order": 2,
"is_default": true,
"description": "Important"
}
]
}Request and response contract
Response 200
Each entry contains a tier key, label, display order, default flag, and description.
Always means present when the parent object exists. A present field can be null. Child fields apply to each array item.
| Field | Type | Returned | Description |
|---|---|---|---|
service_tiers | object[] | Always | The service tiers in configured rank order. |
service_tiers[].key | string | Always | A service-tier key accepted by service requests. |
service_tiers[].label | string | Always | The tier name shown to users. |
service_tiers[].order | integer | Always | The zero-based position of the tier in configured rank order. Minimum: 0. |
service_tiers[].is_default | boolean | Always | Identifies the default tier for new services. |
service_tiers[].description | string | Always | The workspace description of this service tier. |
Errors and recovery (7)
Error responses (7)
- 400
- The API rejected the request because its syntax or one of its values is invalid.
- 401
- The request does not contain valid authentication.
- 403
- Authentication succeeded, but the caller lacks the required API scope or workspace permission.
- 404
- The requested resource does not exist or is not available to the caller.
- 409
- The request conflicts with the current resource state. idempotency_key_reused means that the key belongs to different request content. idempotency_in_progress means that an identical request is still in progress. idempotency_outcome_unknown means that an earlier request may have completed, but its result could not be stored and must not be retried automatically.
- 429
- The workspace exceeded an active request limit.
- 500
- An internal server error prevented completion of the request.