Punk API · JSON Structure

Punkapi Error Structure

Punk API server error envelope returned for 4xx/5xx responses.

Type: object Properties: 3 Required: 2
Food And DrinkBeerBrewDogDIY DogRecipesOpen SourcePublic APIsRESTDeprecated

Error is a JSON Structure definition published by Punk API, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

statusCode error message

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punkapi/refs/heads/main/json-structure/punkapi-error-structure.json",
  "name": "Error",
  "description": "Punk API server error envelope returned for 4xx/5xx responses.",
  "type": "object",
  "required": ["statusCode", "message"],
  "properties": {
    "statusCode": { "type": "int32", "description": "HTTP status code." },
    "error": { "type": "string", "description": "HTTP status text." },
    "message": { "type": "string", "description": "Human-readable error message." }
  }
}