Skip to content

Available static rental locations

GET
/orders/availability
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/orders/availability?allocation_mode=dedicated&network_class=isp' \
--header 'Accept-Language: de' \
--header 'Authorization: Bearer <token>'

List visible tiered rental terms and countries, regions and cities with distinct rentable IP counts for the authenticated customer. Counts include capacity and port constraints; reservation rechecks inventory atomically.

allocation_mode
string
>= 1 characters
Allowed values: dedicated shared
  • dedicated - dedicated * shared - shared
city_id
string format: uuid
country_code
string
>= 2 characters <= 2 characters
network_class
string
>= 1 characters
Allowed values: isp dc
  • isp - isp * dc - dc
region_id
string format: uuid
term_id
string format: uuid
Accept-Language
string
default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples
de

The operation completed successfully.

Media typeapplication/json
object
key
additional properties
Examples
Exampleexample

Example response

{}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
Exampleexample

Validation error

{
"non_field_errors": [
"The request could not be processed."
]
}
Content-Language
string

Language used for human-readable errors.

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
Exampleexample

Authentication required

{
"detail": "Authentication credentials were not provided."
}
Content-Language
string

Language used for human-readable errors.

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
Exampleexample

Permission denied

{
"detail": "You do not have permission to perform this action."
}
Content-Language
string

Language used for human-readable errors.