Get organization policy limits

GET 
/organizations/organization/policy_limits

Returns the computed policy limits for a organization

Scopes

• organizations:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

organization[id] string

All 'organization[]' params are mutually exclusive, only one can be provided.

organization[sub_domain] string

All 'organization[]' params are mutually exclusive, only one can be provided.

Responses

200

Returns the computed policy limits for a organization

application/json

Schema

Schema

policy_limits

object

required

maximum_uninvoiced_balance

object

value floatnullable

unlimited boolean

maximum_virtual_machines

object

value integernullable

unlimited boolean

maximum_virtual_machine_memory

object

value integernullable

unlimited boolean

maximum_disk_space

object

value integernullable

unlimited boolean

maximum_managed_organizations

object

value integernullable

unlimited boolean

maximum_unallocated_ip_addresses

object

value integernullable

unlimited boolean

maximum_security_groups

object

value integernullable

unlimited boolean

maximum_virtual_networks

object

value integernullable

unlimited boolean

maximum_load_balancers

object

value integernullable

unlimited boolean

maximum_dns_zones

object

value integernullable

unlimited boolean

maximum_certificates

object

value integernullable

unlimited boolean

maximum_file_storage_volumes

object

value integernullable

unlimited boolean

maximum_isos

object

value integernullable

unlimited boolean

maximum_disk_size

object

value integernullable

unlimited boolean

minimum_disk_size

object

value integernullable

flexible_virtual_machine_resources boolean

allow_suspension boolean

allow_restricted_traffic_types boolean

Example (from schema)

{
  "policy_limits": {
    "maximum_uninvoiced_balance": {
      "value": 0,
      "unlimited": true
    },
    "maximum_virtual_machines": {
      "value": 0,
      "unlimited": true
    },
    "maximum_virtual_machine_memory": {
      "value": 0,
      "unlimited": true
    },
    "maximum_disk_space": {
      "value": 0,
      "unlimited": true
    },
    "maximum_managed_organizations": {
      "value": 0,
      "unlimited": true
    },
    "maximum_unallocated_ip_addresses": {
      "value": 0,
      "unlimited": true
    },
    "maximum_security_groups": {
      "value": 0,
      "unlimited": true
    },
    "maximum_virtual_networks": {
      "value": 0,
      "unlimited": true
    },
    "maximum_load_balancers": {
      "value": 0,
      "unlimited": true
    },
    "maximum_dns_zones": {
      "value": 0,
      "unlimited": true
    },
    "maximum_certificates": {
      "value": 0,
      "unlimited": true
    },
    "maximum_file_storage_volumes": {
      "value": 0,
      "unlimited": true
    },
    "maximum_isos": {
      "value": 0,
      "unlimited": true
    },
    "maximum_disk_size": {
      "value": 0,
      "unlimited": true
    },
    "minimum_disk_size": {
      "value": 0
    },
    "flexible_virtual_machine_resources": true,
    "allow_suspension": true,
    "allow_restricted_traffic_types": true
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

OrganizationSuspendedSchema

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

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

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

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

Example (from schema)

{}

404

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

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

{
  "code": "organization_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...