API Reference

Katapult Core API

Resources & Endpoints

Get organization policy limits

Returns the computed policy limits for a organization.

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

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

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.

{
    policy_limits: OrganizationPolicy {
        maximum_uninvoiced_balance: DecimalOrUnlimited {
            value: Decimal?
            unlimited: Boolean
        }
        maximum_virtual_machines: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_virtual_machine_memory: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_disk_space: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_managed_organizations: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_unallocated_ip_addresses: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_security_groups: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_virtual_networks: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_load_balancers: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_dns_zones: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_certificates: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_file_storage_volumes: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_isos: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        maximum_disk_size: IntegerOrUnlimited {
            value: Integer?
            unlimited: Boolean
        }
        minimum_disk_size: IntegerValue {
            value: Integer?
        }
        flexible_virtual_machine_resources: Boolean
        allow_suspension: Boolean
        allow_restricted_traffic_types: Boolean
    }
}