Skip to content

Latest commit

 

History

History
129 lines (70 loc) · 4.37 KB

IPAddressSpacesApi.md

File metadata and controls

129 lines (70 loc) · 4.37 KB
Raw

\IPAddressSpacesApi

All URIs are relative to https://cdn.emnify.net

Method HTTP request Description
ip_address_space_available_by_ip_address_version_get get /api/v1/ip_address_space/available Get Random Address Spaces
ip_address_space_by_id_delete delete /api/v1/ip_address_space/{address_space_id} Release an IP Address Space from an Organisation
ip_address_space_by_id_put put /api/v1/ip_address_space/{address_space_id} Assign an IP Address Space to an Organisation
ip_address_space_get get /api/v1/ip_address_space List IP Address Spaces

ip_address_space_available_by_ip_address_version_get

Veccrate::models::RetrieveAvailableAddressSpacesresponse ip_address_space_available_by_ip_address_version_get(ip_address_version) Get Random Address Spaces

Provides a list of 10 random available address spaces (unassigned to any organisation). As the list is generated for each request, two successive requests will have different results.

Parameters

Name Type Description Required Notes
ip_address_version Option<f32> filter by IPv4 which is default or by IPv6. Example: ip_address_version=4 or ip_address_version=6

Return type

Veccrate::models::RetrieveAvailableAddressSpacesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ip_address_space_by_id_delete

ip_address_space_by_id_delete(address_space_id) Release an IP Address Space from an Organisation

Release the IP address space from association with the user's organisation. Note that IP address spaces can only be removed, if the IP address space is not used on any of the organisations endpoints.

Parameters

Name Type Description Required Notes
address_space_id f32 ID of the IP address space to be assigned [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ip_address_space_by_id_put

ip_address_space_by_id_put(address_space_id) Assign an IP Address Space to an Organisation

The IP address space is assigned to the user's organisation.

Parameters

Name Type Description Required Notes
address_space_id f32 ID of the IP address space to be assigned [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ip_address_space_get

Veccrate::models::RetrieveownIpAddressSpacesresponse ip_address_space_get() List IP Address Spaces

Returns the list of IP address space for the requesting user's organisation

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveownIpAddressSpacesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]