OpenAPI Spec to Postman Collection
Royalty Free API Calls - 26
Convert an OpenAPI spec to a Postman Collection to be able to import into your Postman workspace.
Permissions
The Algorithm Platform License is the set of terms that are stated in the Software License section of the Algorithmia Application Developer and API License Agreement. It is intended to allow users to reserve as many rights as possible without limiting Algorithmia's ability to run it as a service.
Learn More
This is necessary for algorithms that rely on external services, however it also implies that this algorithm is able to send your input data outside of the Algorithmia platform.
This allows an algorithm to compose sophisticated functionality using other algorithms as building blocks, however it also carries the potential of incurring additional royalty and usage costs from any algorithm that it calls.
Run an Example
Input
Output
{
"event": [],
"info": {
"_postman_id": "c01d65fe-f4c7-48b2-8fbb-6e86b23cf683",
"description": {
"content": "APIs for managing actions on the Algorithmia platform\n\nContact Support: \n{\n\nName : Algorithmia Support Team\n\nEmail : support@algorithmia.com\n\n}",
"type": "text/plain"
},
"name": "Algorithmia Management APIs",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"version": {}
},
"item": [
{
"event": [],
"id": "bf6ade6e-ff6f-464f-b707-4352d3d1edf5",
"item": [
{
"event": [],
"id": "eefa5b4a-ce34-4abe-99b5-f4b53c05bd2c",
"name": "Creates an Algorithmia user in the system",
"request": {
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"name": "Creates an Algorithmia user in the system",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "96a2d9cf-f506-4c2c-b79f-fa49f2698726",
"name": "User response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 400,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "fd076e76-6042-47c1-af07-2e21a12032b1",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"status": "Bad Request"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "d0fb61e6-0e2f-433c-9a7a-2196cb3eab40",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "e3a5c27b-76b5-42a9-ba9c-e2f421d17a29",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 409,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "13c59825-020c-44f2-9fa5-b7131c12604d",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [],
"variable": []
}
},
"status": "Conflict"
}
]
},
{
"event": [],
"id": "97007f48-9e0e-4d04-b445-6bf98fcc041d",
"name": "Lists all managed users",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "Lists all managed users",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"description": "The number of results to return in a single page",
"key": "limit",
"value": "<integer>"
},
{
"description": "Encoded pagination cursor",
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"next_link\": \"<string>\",\n \"marker\": \"<string>\",\n \"results\": [\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n },\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n }\n ]\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "f64e93b9-8220-43e3-9558-9acfc68a2a30",
"name": "Response for all paginated list apis.",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "ad3cfbbd-46fd-4260-94ef-707cf446ca13",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "7afb1d81-6f83-4f05-ae4b-64a9a27ee9b2",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "Forbidden"
}
]
},
{
"event": [],
"id": "4135c3e6-1710-4574-9d1c-b1b1c276d4c4",
"item": [
{
"event": [],
"id": "ac3d1d0d-dc77-4dd0-a6df-22eee54c8a0d",
"name": "Get a user represented by the provided username",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "Get a user represented by the provided username",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":username"
],
"query": [],
"variable": [
{
"description": {
"content": "The user's username",
"type": "text/plain"
},
"key": "username",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "f2d8b1b0-975a-4f4e-a683-085a30023007",
"name": "User response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 409,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "5cab56ef-6e46-4023-85be-be95d07fc9d7",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Conflict"
}
]
},
{
"event": [],
"id": "aba452b4-62f8-469f-8cbc-2e5ebcfafd70",
"name": "Delete a user represented by the provided username",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"name": "Delete a user represented by the provided username",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":username"
],
"query": [],
"variable": [
{
"description": {
"content": "The user's username",
"type": "text/plain"
},
"key": "username",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 204,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "0dd607af-b0c9-4cec-b631-436f7a4d04a4",
"name": "The delete action was completed successfully.",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "No Content"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "73080d9c-f7ba-427a-92d8-7e5ecd605f4b",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "75409c04-b8a0-459c-96a7-3f6971c5544e",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 500,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "59cf0069-620c-4d8a-b768-048cf5a61e6c",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Internal Server Error"
}
]
},
{
"event": [],
"id": "dfca58cb-ec2f-4074-83ea-f0c6800f6e19",
"name": "Update a user represented by the provided username",
"request": {
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"name": "Update a user represented by the provided username",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":username"
],
"query": [],
"variable": [
{
"description": {
"content": "The user's username",
"type": "text/plain"
},
"key": "username",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "6122a4aa-727d-4d04-9be4-dffcc319efb6",
"name": "User response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 404,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "54569a32-6a97-4926-b8c9-84351e17ec26",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Not Found"
}
]
}
],
"name": "{username}"
}
],
"name": "users"
},
{
"event": [],
"id": "07634fed-d13b-4c06-8942-d299d83071a7",
"item": [
{
"event": [],
"id": "1b52e4ab-4066-4efb-a86d-4ed59d293ce4",
"name": "Lists all organizations",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "Lists all organizations",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [
{
"description": "The number of results to return in a single page",
"key": "limit",
"value": "<integer>"
},
{
"description": "Encoded pagination cursor",
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"next_link\": \"<string>\",\n \"marker\": \"<string>\",\n \"results\": [\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n },\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n }\n ]\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "de114ad4-f0db-4323-b225-1a4aa4b2fcba",
"name": "Response for all paginated list apis.",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "d04645d5-4bb6-4992-aaef-7efe4ebc61ea",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "86db2d1e-105e-4237-8ee9-34669397edb7",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [
{
"key": "limit",
"value": "<integer>"
},
{
"key": "marker",
"value": "<string>"
}
],
"variable": []
}
},
"status": "Forbidden"
}
]
},
{
"event": [],
"id": "4a877dde-2d0c-455c-8e9b-feeafe3c22c6",
"name": "Creates an Organization owned by the caller",
"request": {
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"name": "Creates an Organization owned by the caller",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "edcf1fcb-8bfa-4bb3-b048-deface770144",
"name": "Organization response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 400,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "099e31e3-bf8d-40c2-8751-3768665df2c7",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"status": "Bad Request"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "92803242-2918-4fd6-9cd5-b17eb09fc001",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "53bb638f-8eb2-4fb4-a287-d635e5a857ee",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 409,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "516a61ff-3242-48bc-b082-35b61508bad7",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "POST",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations"
],
"query": [],
"variable": []
}
},
"status": "Conflict"
}
]
},
{
"event": [],
"id": "0cb8cf5a-6e4b-4160-a46f-46b675d2d5db",
"item": [
{
"event": [],
"id": "d35aaea0-7d5b-44a6-8389-30e2193d72ed",
"name": "Get an organization represented by the provided orgName",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "Get an organization represented by the provided orgName",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
":orgName"
],
"query": [],
"variable": [
{
"description": {
"content": "Organization name",
"type": "text/plain"
},
"key": "orgName",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"org_name\": \"<string>\",\n \"org_email\": \"<string>\",\n \"org_label\": \"<string>\",\n \"org_contact_name\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"org_url\": \"<string>\",\n \"self_link\": \"<string>\"\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "4aa56a65-1c8f-4272-86bc-e44c2db9d559",
"name": "Organization response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "6cfbcd20-6f31-4ea2-85ca-8c6cfedfc7aa",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "6b52811b-3fcc-4e5e-a433-92000cb9c806",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 409,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "1d80083f-9e2b-416c-a1de-7b31b53e3316",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Conflict"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 500,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "f1edd921-6c66-4faf-8572-bb5416b8d4f6",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Internal Server Error"
}
]
},
{
"event": [],
"id": "35777205-56fc-470b-adb1-b4268e2f17b3",
"name": "Delete an organization",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"name": "Delete an organization",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
":orgName"
],
"query": [],
"variable": [
{
"description": {
"content": "Organization name",
"type": "text/plain"
},
"key": "orgName",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 204,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "81bd17f0-c5f7-4a4d-aba0-b053554448da",
"name": "The delete action was completed successfully.",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "No Content"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "16af9fe3-2c75-48b0-93cb-483b797eff7a",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "77d73507-c6d1-4541-ab03-8a555b1f733b",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 500,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "5e3a9c97-3509-4929-97ca-1fb0631cbd5f",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Internal Server Error"
}
]
},
{
"event": [],
"id": "24e47c11-5832-4ece-9b7a-8b168650628a",
"item": [
{
"event": [],
"id": "5b9f865f-fda5-482f-901f-799a2b6d04e6",
"name": "List of members with their roles in a given organization",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "List of members with their roles in a given organization",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
":orgName",
"members"
],
"query": [],
"variable": [
{
"description": {
"content": "Organization name",
"type": "text/plain"
},
"key": "orgName",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"next_link\": \"<string>\",\n \"marker\": \"<string>\",\n \"results\": [\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n },\n {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"resource_type\": \"<string>\",\n \"fullname\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_role\": \"<string>\",\n \"self_link\": \"<string>\"\n }\n ]\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "1c85b647-68c8-4146-8542-f72ffa1c6a16",
"name": "Response for all paginated list apis.",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 400,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "436bf7c0-d25e-41ea-97d8-5e35a5e56a4c",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members"
],
"query": [],
"variable": []
}
},
"status": "Bad Request"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "fa9fe3db-1204-4f08-a163-9412216a641c",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "9db655bb-1b04-4edb-aa7f-d3f657f24b4a",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 500,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "a09012ce-62cc-4f07-8cc8-d6aae480d945",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members"
],
"query": [],
"variable": []
}
},
"status": "Internal Server Error"
}
]
},
{
"event": [],
"id": "43cb07aa-84c6-4f09-9079-ad5eba2a2940",
"item": [
{
"event": [],
"id": "cfb569b4-1046-4cdf-aa71-9598caaa2fa0",
"name": "Add a user as a member of a given organization",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"name": "Add a user as a member of a given organization",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
":orgName",
"members",
":username"
],
"query": [],
"variable": [
{
"description": {
"content": "Organization name",
"type": "text/plain"
},
"key": "orgName",
"type": "any",
"value": "<string>"
},
{
"description": {
"content": "The user's username",
"type": "text/plain"
},
"key": "username",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "62a6f754-2b6c-4aca-8159-0f58cb7117ce",
"name": "The user was already a member of this organization",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "OK"
},
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 201,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "8001960d-6b18-49fb-95e4-c632a1e7a476",
"name": "User was succesfully added to the organization",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Created"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "15db827b-719d-4dba-9c4d-ed469f99a793",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "f301e992-628a-4594-8d80-c49933c8ad35",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 404,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "5f07ae69-8400-4bcd-8293-f6d13087322c",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Not Found"
}
]
},
{
"event": [],
"id": "19f18661-17e0-4228-b9df-dba611e9e063",
"name": "Remove a user from an organization",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"name": "Remove a user from an organization",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
":orgName",
"members",
":username"
],
"query": [],
"variable": [
{
"description": {
"content": "Organization name",
"type": "text/plain"
},
"key": "orgName",
"type": "any",
"value": "<string>"
},
{
"description": {
"content": "The user's username",
"type": "text/plain"
},
"key": "username",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 204,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "d40101bd-bcee-4f22-9eb7-22624f36355a",
"name": "User was successfully removed from the organization, was not a member of the organization, or did not exist",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "No Content"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 401,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "092f3115-a626-45c6-9a98-641494dc3a92",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Unauthorized"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "0ef85da0-25d6-47d6-ac27-b19b344e037c",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 404,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "6f433f2c-3190-4ca8-919b-813ebe8abbcc",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "DELETE",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"organizations",
"<string>",
"members",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Not Found"
}
]
}
],
"name": "{username}"
}
],
"name": "members"
}
],
"name": "{org Name}"
}
],
"name": "organizations"
},
{
"event": [],
"id": "2146fe00-235b-490c-9f90-a95b6b731d05",
"item": [
{
"event": [],
"id": "2b419bdc-cd27-49ed-8ca3-90e11b714eee",
"name": "Update the status of a package set build",
"request": {
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"<string>\"\n}"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PATCH",
"name": "Update the status of a package set build",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"builds",
":build_id",
":image_type"
],
"query": [],
"variable": [
{
"description": {
"content": "The id of the package set build",
"type": "text/plain"
},
"key": "build_id",
"type": "any",
"value": "<integer>"
},
{
"description": {
"content": "The image type dependency of the package set build",
"type": "text/plain"
},
"key": "image_type",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 204,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "8e0a74e5-4bc4-453f-8a4f-da523218888b",
"name": "The package set build status was successfully updated",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PATCH",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"builds",
"<integer>",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "No Content"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 403,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "71ab1856-a88a-44c4-bb83-64a56271b85e",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PATCH",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"builds",
"<integer>",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Forbidden"
},
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"error\": {\n \"code\": \"<integer>\",\n \"message\": \"<string>\",\n \"id\": \"<string>\"\n }\n}",
"code": 404,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "ffd0cedd-85e0-4163-884a-9677673da508",
"name": "Error response for all non-200 response",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PATCH",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"builds",
"<integer>",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Not Found"
}
]
},
{
"event": [],
"id": "5a0f5de8-baee-4d18-9102-179bfd1edcb5",
"item": [
{
"event": [],
"id": "a3656a29-2ca9-4e4d-aae9-7bfebc022388",
"name": "Update a package set",
"request": {
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"machine_type\": \"<string>\",\n \"base_builder_image\": \"<string>\",\n \"base_runner_image\": \"<string>\",\n \"language\": \"<string>\",\n \"is_default\": \"<boolean>\",\n \"status\": \"<string>\"\n}"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"name": "Update a package set",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
":package_set_name"
],
"query": [],
"variable": [
{
"description": {
"content": "The name of a package set",
"type": "text/plain"
},
"key": "package_set_name",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 204,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "569d9e45-53de-4a76-b632-c238ffd7db03",
"name": "Update successful",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"machine_type\": \"<string>\",\n \"base_builder_image\": \"<string>\",\n \"base_runner_image\": \"<string>\",\n \"language\": \"<string>\",\n \"is_default\": \"<boolean>\",\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "No Content"
},
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 404,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "eda2e378-dc28-4eb6-bb4e-d621e603e625",
"name": "The package set was not found",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"machine_type\": \"<string>\",\n \"base_builder_image\": \"<string>\",\n \"base_runner_image\": \"<string>\",\n \"language\": \"<string>\",\n \"is_default\": \"<boolean>\",\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Not Found"
},
{
"_": {
"postman_previewlanguage": "text"
},
"body": "",
"code": 500,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"id": "fa557e78-6fd1-4b61-99dd-a0f7275cb18d",
"name": "Internal server error",
"originalRequest": {
"body": {
"mode": "raw",
"raw": "{\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"machine_type\": \"<string>\",\n \"base_builder_image\": \"<string>\",\n \"base_runner_image\": \"<string>\",\n \"language\": \"<string>\",\n \"is_default\": \"<boolean>\",\n \"status\": \"<string>\"\n}"
},
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"method": "PUT",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"<string>"
],
"query": [],
"variable": []
}
},
"status": "Internal Server Error"
}
]
},
{
"event": [],
"id": "027816fb-0300-4735-91d3-b461b6f995ce",
"name": "Name of a package set",
"request": {
"auth": {
"type": "noauth"
},
"description": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"name": "Name of a package set",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
":package_set_name",
"builds"
],
"query": [],
"variable": [
{
"description": {
"content": "The name of a package set",
"type": "text/plain"
},
"key": "package_set_name",
"type": "any",
"value": "<string>"
}
]
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"body": "{\n \"builds\": [\n {\n \"packageSetBuildId\": \"<integer>\",\n \"packageSetName\": \"<string>\",\n \"imageTag\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"isDeprecated\": \"<boolean>\",\n \"version\": \"<integer>\"\n },\n {\n \"packageSetBuildId\": \"<integer>\",\n \"packageSetName\": \"<string>\",\n \"imageTag\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"isDeprecated\": \"<boolean>\",\n \"version\": \"<integer>\"\n }\n ]\n}",
"code": 200,
"cookie": [],
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"id": "7b9afc05-cfde-4a7b-99d8-23aaa023e97d",
"name": "List of package set builds",
"originalRequest": {
"body": {},
"header": [
{
"key": "Authorization",
"value": ""
}
],
"method": "GET",
"url": {
"host": [
"{{baseUrl}}"
],
"path": [
"package-sets",
"<string>",
"builds"
],
"query": [],
"variable": []
}
},
"status": "OK"
}
]
}
],
"name": "{package set name}"
}
],
"name": "package-sets"
}
],
"variable": [
{
"id": "baseUrl",
"type": "string",
"value": "https://api.algorithmia.com/v1"
}
]
}Install and Use
Install
Install the Algorithmia CLI client by running:
curl -sSLf https://algorithmia.com/install.sh | shThen authenticate by running:
algo auth
# Enter API Key: YOUR_API_KEY