Use these conventions to interpret endpoint paths and JSON property tables in this API documentation.
Endpoint paths
Each endpoint includes an HTTP method and a path:
GET /raven/v3/codesCurly braces ({ }) in a path identify a placeholder that you replace with a value. For example, replace {id} with the ID of the forward you want to update:
PUT /jacaerys/v1/forwards/{id}Request and response properties
Request and response bodies are documented in JSON property tables. Each table identifies a property's:
- Data type
- Read-only status
- Required status
- Description