REST API · requests

GET /requests/{requestId}

Single request envelope + every per-target attempt, scoped to the token's project. Returns 404 once the request has aged out of the project's log-retention window.

get_api_requests_show

Authentication

  • Bearer

Parameters

NameInRequiredSchemaDescription
requestId path yes {"type":"string","pattern":"[0-9a-fA-F-]{36}"}

Responses

200

One request and its per-target delivery attempts.

application/json

{
    "properties": {
        "request": {
            "properties": {
                "configVersion": {
                    "description": "Published config that authorised the request; 0 means unstamped.",
                    "type": "integer",
                    "minimum": 0
                }
            },
            "type": "object"
        },
        "attempts": {
            "type": "array",
            "items": {
                "properties": {
                    "configVersion": {
                        "description": "Published config that authorised the delivery attempt; 0 means unstamped.",
                        "type": "integer",
                        "minimum": 0
                    }
                },
                "type": "object"
            }
        }
    },
    "type": "object"
}
{
    "request": {
        "ts": 1768464000000,
        "requestId": "a1b2c3d4-5e6f-4a1b-8c2d-9e0f1a2b3c4d",
        "method": "POST",
        "path": "/v1/lifecycle",
        "status": 200,
        "durationMs": 42,
        "targets": 1,
        "creditsDeducted": 5,
        "authType": "apiKey-live",
        "errorMessage": null,
        "bytesSent": 1024,
        "closeReason": "complete",
        "configVersion": 7
    },
    "attempts": [
        {
            "ts": 1768464000500,
            "targetId": "b2c3d4e5-6f7a-4b2c-8d3e-0f1a2b3c4d5e",
            "targetURL": "https://api.support-vendor.example/lifecycle",
            "attempt": 1,
            "outcome": "success",
            "status": 200,
            "durationMs": 180,
            "errorMessage": null,
            "configVersion": 7
        }
    ]
}

← REST API reference