{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e4cea45f-9e6c-4be6-b804-dc758c8dedcf","name":"Apteriks REST API","description":"Welcome to Apteriks REST API !\n\n---\n\n# Overview\n\nApteriks API exposes the majority of Apteriks functionality via a standardized programmatic interface. Using our API, you can do just about anything you can do on apteriks.com, while using your programming language of choice.\n\nThe easiest way to start using our API is by clicking the Run in Postman button above. Postman is a free tool which helps developers run and debug API requests without building any client environment.\n\n---\n\n# Enabling REST API\n\nBy default the API functionality is disabled. In order to enable it, log in to the Apteriks portal and navigate to Your Account > REST API Settings.\n\nEnable the REST API functionality and obtain your API key.\n\n---\n\n# Authentication\n\nEvery API request must be authenticated. Authentication to the API is performed using **Bearer authentication**.  \nAs such, every API request must carry the Authorization token with your API key:\n\n```\nRequest headers:\n   Authorization: Bearer YOUR-API-KEY-HERE\n\n ```\n\nPlease note:\n\n- All API requests must be made over HTTPS.\n    \n- Calls made over plain HTTP will fail.\n    \n- API requests without authentication will also fail.\n    \n\n---\n\n# Authorization\n\nYou can control Read/Write privileges of your API account on REST API Settings page. The following access levels have been defined.\n\n- **Disabled**. The credentials of your API account remain intact, but the access to the information is denied. Use this access level when you want to disable API function without completely removing API authentication credentials.\n    \n- **Read Only**. You will be able to obtain data via API GET calls, but will not be able to change existing data or create new data using POST, PUT or DELETE API calls.\n    \n- **Read Write**. You have full access to your data.\n    \n\n---\n\n# Request methods\n\nApteriks uses the following HTTP Methods\n\n- `GET` - Read the object details. This method can be executed with Read Only API access privileges.\n    \n- `POST` - Create the new object. This method requires Read Write API access privileges.\n    \n- `PUT` - Modify the existing object. This method requires Read Write API access privileges.\n    \n- `DELETE` - Delete the object. This method requires Read Write API access privileges.\n    \n\n## X-HTTP-Method-Override\n\nIn some cases you may not use any other methods except GET and POST. This may be due to limitations of HTTP proxies, your firewall settings, or browser restrictions. In that case in order to execute PUT or DELETE requests, send the POST request but include the X-HTTP-Method-Override header.\n\n- A **POST** request with X-HTTP-Method-Override header equal to \"PUT\" will be treated as native **PUT** request.\n    \n- A **POST** request with X-HTTP-Method-Override header equal to \"DELETE\" will be treated as native **DELETE** request.\n    \n\n---\n\n# Response format\n\n## JSON vs XML\n\nThe data can be returned in both JSON and XML formats. We recommend to use JSON as it is more lightweight and easier to parse.\n\n- Set the **ACCEPT** HTTP header to \"application/json\" in order to receive the response in JSON format.\n    \n- Set the **ACCEPT** HTTP header to \"application/xml\" in order to receive the response in XML format.\n    \n\n## Response codes\n\nApteriks uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the `2xx` range indicate success, codes in `4xx` range indicate errors on the client side, and codes in `5xx` range indicate errors on the server side.\n\n## \"Success\" response structure\n\nWhen the HTTP response code is in `2xx` range, the response body contains the requested object(s).\n\n## \"Error\" response structure\n\nUnsuccessful API response with HTTP status codes `4xx` or `5xx` return the following object in the response body.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| IsSuccess | boolean | FALSE as an indication of an unsuccessful request |\n| Code | integer | HTTP response code |\n| Message | string | Empty if the requested operation was successfully completed. In case of error this field contains the description of error. |\n| ModelState | ModelState object | During POST or PUT requests, the submitted data is validated for correctness. In case of out-of-range or missing values this field contains the description of errors. In other cases this field is NULL. Refer to Model Validation section. |\n\n---\n\n# Errors\n\nLet's look at several most common error scenarios.\n\n## Incorrect URL\n\nAn incorrect URL was used for contacting Apteriks API.\n\nResponse: HTTP 404 (NOT FOUND) with the message \"Incorrect Request-URI does not match any resource\".\n\n## Missing resource\n\nThe request URL is correct but the requested resource is missing.\n\nResponse: HTTP 404 (NOT FOUND) with the message \"Entity not found\".\n\n## Authentication failure\n\nEither a combination of authentication Username/Password is incorrect, or assigned API privileges are not sufficient to perform the requested action.\n\nResponse: HTTP 401 (UNAUTHORIZED) with the message \"Authorization has been denied for this request\".\n\n## Model Validation error\n\nWith POST or PUT requests, request body must contain the object data in the correct format. When the format of data fails the validation, the response with ModelState object provides the detailed error list for every failed condition.\n\nResponse: HTTP 400 (BAD REQUEST) with the message \"Model state is invalid\" and ModelState detailing the errors.\n\n## Subscription quota error\n\nAn attempt to store more data than allowed for your subscription plan will result in the following response.\n\nResponse: HTTP 402 (PAYMENT REQUIRED)\n\n---\n\n# Pagination\n\n## Server enforced paging\n\nSome GET requests may return a lot of data. In order to prevent the flooding, this data is supplied in pages with maximum default size of 100 entries. The **X-Total-Count** response header provides the total amount of entries, so that the pagination can be used to navigate through them.\n\nPagination is implemented using \"skip\" parameter.\n\n## **How to retrieve all entries in a table**\n\nFirst step. Retrieve first page in a table and check X-Total-Count response header .\n\n```\nExample:\nRequest: /ipam/ipv4/networks\nResponse: returns first (default) page of data, entries 1 to 100. \nIn this example X-Total-Count response header is set to 340.\n\n ```\n\nFollowing steps: Based on the amount of learned entries, perform consequtive requests.\n\n```\nExample\nRequests:\n/ipam/ipv4/networks?skip=100 - returns entries 101 to 200\n/ipam/ipv4/networks?skip=200 - returns entries 201 to 300\n/ipam/ipv4/networks?skip=300 - returns entries 301 to 340\n\n ```\n\n# DateTime format\n\nMany API objects have timestamps that are supplied in Greenwich Mean Time (GMT) timezone, sometimes also called Coordinated Universal Time (UTC). Note that this timezone never changes for Daylight Saving Time (DST)\n\nAll timestamps have the following format.\n\n**yyyy-MM-ddTHH:mm:ss.FFF**\n\n| Field | Meaning |\n| --- | --- |\n| yyyy | The year as a four-digit number |\n| MM | The month, from 01 through 12 |\n| dd | The day of the month, from 01 through 31 |\n| T | Letter \"T\" as a separator between the Data and Time fields |\n| HH | The hour, using a 24-hour clock from 00 to 23 |\n| mm | The minute, from 00 through 59 |\n| ss | The second, from 00 through 59 |\n| FFF | If non-zero, the milliseconds in a date and time value |\n\n**Example**\n\n```\n{\n    \"CreateTime\": \"2016-06-14T07:23:59.98\", \n    \"ModifyTime\": \"2016-06-27T12:13:16.597\" \n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4296112","team":18243977,"collectionId":"e4cea45f-9e6c-4be6-b804-dc758c8dedcf","publishedId":"S17xqQSb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4296112/S17xqQSb","privateUrl":"https://go.postman.co/documentation/4296112-e4cea45f-9e6c-4be6-b804-dc758c8dedcf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2019-04-01T09:41:47.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"05ff2052-b569-4629-8a6a-4bf1191bc7cb","owner":"4296112","values":[{"key":"YourApiKey","value":"Your-API-Key-Here","enabled":true},{"key":"ServerUrl","value":"https://www.apteriks.com/api/v1","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/defa90e3f3a111a481645f9a7936dc6e8ec0bf01838eedb79925f1b85ac0c1c2","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"4296112-05ff2052-b569-4629-8a6a-4bf1191bc7cb"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S17xqQSb"}