List Autonomus-systems

GET /autonomous-system
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/autonomous-system

Returns a list of Autonomus-systems

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
idinteger
Unique ASN - autonomous system number
asninteger
ASN - autonomous system number


Example: asn=55734
asointeger
ASO - autonomous system organization


Example: aso=020 ICT
ispstring
Name of the Internet service provider.


Example: isp=001 IT Complex
organizationinteger
Name of the organization


Example: organization=001 IT Complex
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ autonomous-system ]
An array of all created items.
Autonomous System
Name
Description
asnnumber (integer)
Name of the Autonomous System Numbers.


Example: 55734
asostring
Name of the App Store Optimization.


Example: 001 IT Complex
idstring
A unique identifier generated by the Ocamba platform.


Example: 55734
ispstring
Name of the Internet service provider.


Example: 001 IT Complex
organizationstring
Name of the organization.


Example: 001 IT Complex
totalinteger
A total number of items.


Example: 70819
tip
1 Searchable fields are: aso, isp and organization.
2 Sortable fields are: id, asn, aso, isp and organization.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 70819,
    "items": [
        {
          "id": "55734",
          "asn": 55734,
          "aso": "001 IT Complex",
          "isp": "001 IT Complex",
          "organization": "001 IT Complex"
        },
        {
          "id": "60502",
          "asn": 60502,
          "aso": "01 System Srl",
          "isp": "01 System Srl",
          "organization": "01 System Srl"
        },
        {
          "id": "209288",
          "asn": 209288,
          "aso": "020 ICT",
          "isp": "020 ICT",
          "organization": "020 ICT"
        }
    ]
}

{
  "total": 70819,
  "items": [
    {
      "id": "55734",
      "asn": 55734,
      "aso": "001 IT Complex",
      "isp": "001 IT Complex",
      "organization": "001 IT Complex"
    }
  ]
}