{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bb525e57-53af-4e27-b955-c2e40598c765","name":"REST APIs V2","description":"MainStreaming APIs allow you to create, update, and manage content on the MainStreaming platform in order to distribute them in the world in the best way.\n\nThis document is created for developers who want to integrate MainStreaming services inside their workflow.\n\nOur APIs are based on the REST methodology: they are made up of intuitive, resource-oriented URLs and use HTTP statuse codes for error handling.\n\nWe use JSON Web Tokens (JWT) as a mechanism to transport auth claims and through credentials it is possible to generate tokens to interact with our secure and efficient APIs.\n\nThe APIs are protected by permissions, called scopes, which must be specified when generating a token: tokens may have all the scopes available to your credentials or may be limited to a subset of them for specific purposes.\n\nIt's also possible to limit the IP addresses from which a token will be allowed to be used, or to not limit the set of IP addresses, which is more common in cloud environments.\n\nThe standard format used throughout our APIs is JSON, for both successful responses and failed ones.\n\nNB: The double curly brackets (ex: {{string}}) must not be included in your codes. We use them to indicate the insertion of a variable.\n\n## API AREAS\n\nOur APIs are divided into different macro areas:\n\n- Authentication API: creation and view of token status\n    \n- Property Management API: configuration and view of property status\n    \n- Media Asset Management API: complete management of on-demand, playlist, live and origin content\n    \n- Encoding Profiles API: creation of encoding profiles for content\n    \n- Player Management API: creation of player skins\n    \n- Activities API: list of activities performed through the tokens connected to the property\n    \n- CDN Management API: management of CDN-level resources, like security profiles\n    \n\n## ENDPOINT\n\nThe public endpoint for our API library is: [https://api.msmdn.net/v2](https://api.msmdn.net/v2) .\n\nIf White Label mode is configured, the MainStreaming DNS proxy will allow you to access the endpoint within your root domain. Example: [https://api.mydomain.com/v2](https://api.mydomain.com/v2)\n\n## REQUEST METHODS\n\nFollowing the REST methodology, with an eye for a pragmatic approach, we use the typical HTTP methods to express different kinds of actions.\n\n| Method | Description |\n| --- | --- |\n| GET | Request one or more resources |\n| POST | Create a resource and execute certain custom actions |\n| PUT | Update a resource |\n| DELETE | Delete a resource |\n\n## HTTP SUCCESS STATUS CODES\n\n| Code | Description |\n| --- | --- |\n| 200 | Success - Request successfully completed |\n| 201 | Created - Request successfully created (POST calls) |\n\n## HTTP ERROR STATUS CODES\n\n| Code | Description |\n| --- | --- |\n| 400 | Bad Request - Parameters sent are incorrect |\n| 401 | Unauthorized - Missing token or incorrect syntax |\n| 403 | Forbidden - Insufficient permissions or expired tokens |\n| 404 | Not Found - Element not found |\n| 405 | Not Allowed - Invalid request |\n| 415 | Unsopported Media Type - Content-Type invalid |\n| 500 | Internal Error - Internal system error (contact us) |\n\n## RESPONSE DATA\n\n| Field | Type | Description |\n| --- | --- | --- |\n| code | integer | Answering code |\n| status | string | Textual status of the answer |\n| isSuccessStatusCode | boolean | Boolean that rappresent if the api call has been success or not |\n| data | object | Object of a get call that returns a specific element |\n|  | array | List of objects of a get call that returns multiple elements |\n|  | boolean | Boolean of a put or delete call that identifies the status of the operation |\n|  | string | A string or guid that represents the identfier of an element created |\n\n## HTTP REQUEST REQUIRED FIELDS\n\nThroughout the document we’ve indicated required fields to pass to the APIs by adding an asterisk next to the name/field.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5221006","collectionId":"bb525e57-53af-4e27-b955-c2e40598c765","publishedId":"S1a8zQoH","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5221006/S1a8zQoH","privateUrl":"https://go.postman.co/documentation/5221006-bb525e57-53af-4e27-b955-c2e40598c765","customColor":{"top-bar":"303030","right-sidebar":"303030","highlight":"EB222F"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-12-10T13:07:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1a8zQoH"}