API Reference

Katapult Core API

Resources & Endpoints

List IP addresses

Returns a list of all IP addresses belonging to an organization.

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

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

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

The organization to use when looking up IP addresses

 Organization Lookup None

allocated

If true, only return allocated IP addresss. If false, only return unallocated IP addresses.

 Boolean None

page

Integer 1

per_page

Integer 30

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

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

Returned Object

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

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    ip_addresses: [ IPAddress {
        id: String
        address: String
        reverse_dns: String
        vip: Boolean
        allocation_id: String?
        allocation_type: String?
    } ]
}