API Reference

Katapult Core API

Resources & Endpoints

Get zone

Returns the details for a specific zone.

GET
https://api.katapult.io/core/v1/zones/{zone}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

zone Required

The zone to find

 Zone Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

zone_not_found

No zone was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    zone: Zone {
        id: String
        name: String
        permalink: String?
        data_center: DataCenter {
            id: String
            name: String
            permalink: String?
            country: Country {
                id: String
                name: String
                iso_code2: String
                iso_code3: String
                time_zone: String?
                eu: Boolean
            }
        }
    }
}