Get organization limits and usage

GET 
/organizations/organization/policy

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_type PolicyType (string)required

Possible values: [auto, override, none]

policy_name stringnullablerequired

limits

object

required

uninvoiced_balance

object

limit float

current float

currency

object

id string

name string

iso_code string

symbol string

virtual_machines

object

limit integer

current integer

unit stringnullable

virtual_machine_memory

object

limit integer

current integer

unit stringnullable

managed_organizations

object

limit integer

current integer

unit stringnullable

unallocated_ip_addresses

object

limit integer

current integer

unit stringnullable

disk_space

object

limit integer

current integer

unit stringnullable

security_groups

object

limit integer

current integer

unit stringnullable

virtual_networks

object

limit integer

current integer

unit stringnullable

load_balancers

object

limit integer

current integer

unit stringnullable

dns_zones

object

limit integer

current integer

unit stringnullable

certificates

object

limit integer

current integer

unit stringnullable

file_storage_volumes

object

limit integer

current integer

unit stringnullable

isos

object

limit integer

current integer

unit stringnullable

disk_iops

object

limit integer

unit stringnullable

network_speed

object

limit integer

unit stringnullable

features

object

required

disk_bus_configuration

object

permitted boolean

zone_selection

object

permitted boolean

restricted_traffic_types

object

permitted boolean

suspension

object

permitted boolean

flexible_virtual_machine_resources

object

permitted boolean
reasons_for_disallowing_resource_creation string[]required

Example (from schema)

{
  "policy_type": "auto",
  "policy_name": "string",
  "limits": {
    "uninvoiced_balance": {
      "limit": 0,
      "current": 0,
      "currency": {
        "id": "string",
        "name": "string",
        "iso_code": "string",
        "symbol": "string"
      }
    },
    "virtual_machines": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "virtual_machine_memory": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "managed_organizations": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "unallocated_ip_addresses": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "disk_space": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "security_groups": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "virtual_networks": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "load_balancers": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "dns_zones": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "certificates": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "file_storage_volumes": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "isos": {
      "limit": 0,
      "current": 0,
      "unit": "string"
    },
    "disk_iops": {
      "limit": 0,
      "unit": "string"
    },
    "network_speed": {
      "limit": 0,
      "unit": "string"
    }
  },
  "features": {
    "disk_bus_configuration": {
      "permitted": true
    },
    "zone_selection": {
      "permitted": true
    },
    "restricted_traffic_types": {
      "permitted": true
    },
    "suspension": {
      "permitted": true
    },
    "flexible_virtual_machine_resources": {
      "permitted": true
    }
  },
  "reasons_for_disallowing_resource_creation": [
    "string"
  ]
}

400

400 error response

application/json

Schema

Schema

oneOf

APIAuthenticator400Schema

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

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string

detail object

PolicyNotAvailableForManagedOrganizationsSchema

Managed organizations do not have policies. Make this request on the parent organization instead.

code PolicyNotAvailableForManagedOrganizationsEnum (string)

Possible values: [policy_not_available_for_managed_organizations]

description string

detail object

Example (from schema)

{}

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...