List Address Spaces

List Address Spaces

Returns a collection of address spaces with specified paging, sorting and filtering parameters, sorting and filtering parameters.

Request
URI
GET
https://{api_host}/ipam-service//api/providers/{providerEndpointId}/address-spaces
COPY
Path Parameters
string
providerEndpointId
Required

The provider endpoint id, registered with the endpoint-service.

Query Parameters
string
additionalFilter
Optional

Additional filter in the provider specific format. Note: filter string needs to be URL encoded.

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Request Body
PageAndSortRequest of type(s) application/json
Optional
{
    "pageNumber": 0,
    "offset": 0,
    "pageSize": 0,
    "queryInfo": {
        "expand": [
            {
                "propertyName": "string"
            }
        ],
        "select": [
            {
                "propertyName": "string"
            }
        ],
        "top": 0,
        "skipToken": "string",
        "inlineCount": "string",
        "orderBy": [
            {
                "direction": "string"
            }
        ],
        "skip": 0,
        "rawFilter": "string",
        "rawOrderBy": "string"
    }
}
integer As int32 As int32
pageNumber
Optional

pageNumber

integer As int32 As int32
offset
Optional

offset

integer As int32 As int32
pageSize
Optional

pageSize

sort
Optional

sort

queryInfo
Optional

queryInfo

Responses
200

Success - return the collection of AddressSpaces for a given provider endpoint id.

Returns pagedEntities of type(s) */*
{
    "metadata": {
        "number": 0,
        "size": 0,
        "offset": 0,
        "totalPages": 0,
        "totalElements": 0
    },
    "links": [
        {
            "rel": "string",
            "href": "string"
        }
    ],
    "content": [
        {}
    ]
}
metadata
Optional

metadata

array of Link
links
Optional

links

array of object
content
Optional

content


403

Forbidden.

Operation doesn't return any data structure

404

Resource not found.

Operation doesn't return any data structure