Skip to main content

Find zones by filtering criteria

GET 
/projects/:projectId/zones

Return zones that match all searching criteria. Criteria are project identifier, region, country code and city.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

Query Parameters

    region string

    Region

    • AMER: South and North America
    • APAC: Asia, Pacific
    • EUR: Europe
    • IMEAR: rest of the world
    countryCode string

    Possible values: >= 2 characters and <= 2 characters

    Country code (on 2 characters)

    city string

    City of the POP

    offset int32

    Default value: 0

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    limit int32

    Possible values: >= 1

    Default value: 100

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

    X-API-Key string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Response Headers

  • X-Total-Count

    integer

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

  • X-Result-Count

    integer

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema

  • Array [

    • name stringrequired

    Unique resource name.

    description string

    Resource description.

    region stringrequired

    Region

    • AMER: South and North America
    • APAC: Asia, Pacific
    • EUR: Europe
    • IMEAR: rest of the world
    countryCode stringrequired

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression [A-Z]{2}

    Country code (on 2 characters)

    city stringrequired

    City name

  • ]

Loading...