Immutable source snapshot
POST /v1/ide/source-open-commands/{command_id}/ack
Acknowledge source open command. Permissions, parameters, responses and examples.
This address preserves one reviewed source snapshot. Use the current entry point for the selected documentation version.
Read pinned handler: apps/api/kodesec_api/ide_source.py:432
Acknowledge source open command
Acknowledge source open command through POST /v1/ide/source-open-commands/{command_id}/ack. The parameters and declared response shapes below come from this exact source snapshot.
Source preview; no stable third-party integration promise. This page makes no request to a local installation.
Authority
Browser operator session or exact IDE capability with source:open-ack. Route-specific ownership and generation checks also apply.
Browser mutations require the exact control Origin and session-bound CSRF header. IDE callers use only their admitted route scope and exact generation.
Parameters and headers
| Name | Location | Contract |
|---|---|---|
command_id | path Required | string Schema |
X-CSRF-Token | header Conditional / optional | Required for browser mutations with the exact control Origin. Not an IDE capability. Schema |
Request body
JSON body · required · SourceOpenAck
| Field | Type | Presence |
|---|---|---|
error_code | string | null | Optional |
status | string | Required |
Complete declared request schema
{
"additionalProperties": false,
"properties": {
"error_code": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Code"
},
"status": {
"enum": [
"opened",
"failed"
],
"title": "Status",
"type": "string"
}
},
"required": [
"status"
],
"title": "SourceOpenAck",
"type": "object"
}Responses
| Status | Meaning and declared shape |
|---|---|
200 | Successful Response application/json · object |
400 | Exact host, malformed request or URL credential refusal application/json · object |
401 | Missing or invalid membership application/json · object |
403 | Exact origin, CSRF or route authority refusal application/json · object |
404 | Refresh the collection and verify the resource identity before retrying. See source-linked error catalog. |
409 | Refresh current revision and identity. A conflicting command must not be blindly repeated. See source-linked error catalog. |
422 | Validation Error application/json · HTTPValidationError |
429 | Authentication rate or connection limit application/json · object |
An empty or broad schema preserves the source contract. It is not a promise of an empty response.
Source-linked errors
Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.
6 source error observations
| Status | Source detail | Recovery |
|---|---|---|
| 409 ↗ | {"action":"request_source_open_again","code":"ide_source_command_expired","message":"The source-open command expired before the IDE acknowledged it."} | Refresh current revision and identity. A conflicting command must not be blindly repeated. |
| 422 ↗ | A failed source-open acknowledgement requires a safe error_code | Correct the field or semantic validation error. Input values are omitted from control validation errors. |
| 422 ↗ | An opened source-open acknowledgement cannot include error_code | Correct the field or semantic validation error. Input values are omitted from control validation errors. |
| 409 ↗ | source-open command already has a different terminal acknowledgement | Refresh current revision and identity. A conflicting command must not be blindly repeated. |
| 404 ↗ | source-open command not found | Refresh the collection and verify the resource identity before retrying. |
| 404 ↗ | source-open command not found | Refresh the collection and verify the resource identity before retrying. |
Synthetic examples
These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.
Request JSON
{
"status": "opened"
}Response 200 JSON
{}All referenced models remain in its components section. Browse control model definitions.