API Reference

Katapult Core API

Resources & Endpoints

List networks

Returns a list of all networks available for an organization.

GET
https://api.katapult.io/core/v1/organizations/{organization}/available_networks

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

Organization Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

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

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

Returned Object

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

{
    networks: [ Network {
        id: String
        name: String
        permalink: String?
        data_center: DataCenter {
            id: String
            name: String
            permalink: String
        }
    } ]
    virtual_networks: [ VirtualNetwork {
        id: String
        name: String
        data_center: DataCenter {
            id: String
            name: String
            permalink: String
        }
    } ]
}