Scheda dell'endpoint

POST /health

Check API health

System POST

Endpoint

Scegli l'ambiente e l'indirizzo cambia con lui.

http://173.249.30.252/spedireweb/api/health

Richiesta

Quelli segnati come necessari non si possono omettere.

2
Nome Dove Tipo Serve Descrizione
Accept header string Sì Expected response format.
Content-Type header string No Request body format when a JSON body is sent.
Accept Serve
header string

Expected response format.

Content-Type
header string

Request body format when a JSON body is sent.

Esempio richiesta

Metti il tuo token dove c'è scritto TOKEN.

cURL 
curl -X POST "http://173.249.30.252/spedireweb/api/health" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json"

Risposta

Un blocco per ogni risposta che l'endpoint può dare.

6 

{
    "success": true
}

{
    "error": {
        "code": "REQUEST_1001",
        "message": "Invalid request."
    },
    "success": false,
    "request_id": "req_01k5example000000000000000"
}

{
    "error": {
        "code": "APP_1004",
        "message": "Resource not found."
    },
    "success": false,
    "request_id": "req_01k5example000000000000000"
}

{
    "error": {
        "code": "VALIDATION_1001",
        "message": "Validation failed."
    },
    "success": false,
    "request_id": "req_01k5example000000000000000"
}

{
    "error": {
        "code": "RATE_LIMIT_1001",
        "message": "Too many requests."
    },
    "success": false,
    "request_id": "req_01k5example000000000000000"
}

{
    "error": {
        "code": "SERVER_1001",
        "message": "Internal server error."
    },
    "success": false,
    "request_id": "req_01k5example000000000000000"
}

Da sapere

Returns the current health status of the API. Public endpoint.

N questa pagina

Endpoint Richiesta Esempio richiesta Risposta Da sapere