The Super API is built on REST principles. It features predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON responses, and adheres to standard HTTP response codes and verbs.
\nThe Super API utilizes a two-factor authentication approach for enhanced security, requiring both a client certificate and a bearer token for successful authentication.
\n.crt or .pem format) and its corresponding private key (.key or .pem format) from the Superclouds Console.api.superclouds.ooo)..crt and .key (or .pem) files.In addition to the client certificate, you'll need a valid bearer token for each request.
\n** Please ensure to add your downloaded cert in your code along with the bearer token for a successfull request / response
\nFor example :
const cert = fs.readFileSync('/path/to/client.crt');
const key = fs.readFileSync('/path/to/client.key');
(or)
\ncert, err := tls.LoadX509KeyPair(\"/path/to/client.crt\", \"/path/to/client.key\")
if err != nil {
panic(err)
}
(or) similar in your choice of language.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25556074","collectionId":"e13247e4-aa6b-463c-b83f-e9b80ac40097","publishedId":"2sA3JQ5L4h","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"f81c06"},"publishDate":"2024-05-14T20:56:09.000Z"},"item":[{"name":"Users","item":[{"name":"Users","event":[{"listen":"test","script":{"id":"ce9a3c4d-7a30-4819-bd3f-5220878b8166","exec":["// Removed redundant test"],"type":"text/javascript","packages":{}}}],"id":"45599f7e-e147-4027-b1bf-d913a25c650a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.superclouds.ooo/v1/users","description":"Retrieve a paginated list of users belonging to an organization. This endpoint allows for filtering users based on a search term.
\nRequest Parameters:
\nsize (optional, integer): The number of users to return per page. Default is 10.
\npage (optional, integer): The page number to retrieve. Default is 1.
\ns (optional, string): A search term to filter users by their first name, last name, or email.
\n(optional, integer): The number of users to return per page. Default is 10.
\n","type":"text/plain"},"key":"size","value":"10"},{"disabled":true,"description":{"content":"(optional, integer): The page number to retrieve. Default is 1
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"(optional, string): A search term to filter users by their first name, last name, or email
\n","type":"text/plain"},"key":"s","value":"john"}],"variable":[]}},"response":[{"id":"0a432114-0965-416c-b73f-b0c246a68b92","name":"Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM"}],"url":{"raw":"https://api.superclouds.ooo/v1/users?size=10&page=1&s=john","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","users"],"query":[{"key":"size","value":"10","description":"(optional, integer): The number of users to return per page. Default is 10."},{"key":"page","value":"1"},{"key":"s","value":"john"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"60a1e34f8c3c923674175b0a\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"role\": \"SUPER\"\n },\n {\n \"id\": \"60a1e34f8c3c923674175b0b\",\n \"email\": \"jane.smith@example.com\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"role\": \"READ\"\n }\n ],\n \"message\": \"User List\",\n \"page\": 1,\n \"pages\": 1,\n \"size\": 2,\n \"status\": 1,\n \"total\": 2\n}"},{"id":"6d246bcd-6e21-4b7c-8d19-e9b400f8f7cc","name":"400","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.superclouds.ooo/v1/users","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","users"],"query":[{"key":"size","value":"10","description":"(optional, integer): The number of users to return per page. Default is 10.","disabled":true},{"key":"page","value":"1","description":"(optional, integer): The page number to retrieve. Default is 1","disabled":true},{"key":"s","value":"john","description":"(optional, string): A search term to filter users by their first name, last name, or email","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": -1,\n \"message\": \"Invalid request parameters.\"\n}"},{"id":"e867be13-62c9-4d8c-9dfe-3a12d6834a06","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.superclouds.ooo/v1/users","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","users"],"query":[{"key":"size","value":"ten","description":"(optional, integer): The number of users to return per page. Default is 10.","disabled":true},{"key":"page","value":"one","description":"(optional, integer): The page number to retrieve. Default is 1","disabled":true},{"key":"s","value":"john","description":"(optional, string): A search term to filter users by their first name, last name, or email","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": -1,\n \"message\": \"You are not authorized.\"\n}"},{"id":"fe0a21ae-34c4-47aa-a46c-256b0a77a394","name":"404","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.superclouds.ooo/v1/users","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","users"],"query":[{"key":"size","value":"10","description":"(optional, integer): The number of users to return per page. Default is 10.","disabled":true},{"key":"page","value":"1","description":"(optional, integer): The page number to retrieve. Default is 1","disabled":true},{"key":"s","value":"john","description":"(optional, string): A search term to filter users by their first name, last name, or email","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": -1,\n \"message\": \"No user found.\"\n}"}],"_postman_id":"45599f7e-e147-4027-b1bf-d913a25c650a"},{"name":"User Details","id":"e5a4d8d6-fc7d-4e03-81a1-4593b43e45be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.superclouds.ooo/v1/user","description":"Retrieve detailed information about the authenticated user.
\nRequest Parameters:
This endpoint does not require any query parameters. The user's details are retrieved based on the authenticated session.
Update details of the authenticated user. Only the specified fields will be updated, allowing for partial updates.
\nRequest Parameters:
This endpoint requires a JSON body with the fields to be updated. All fields are optional and can include:
first_name (string): The user's first name.
\nlast_name (string): The user's last name.
\ncontact (string): The user's contact information.
\nAllows the authenticated user to change their password by providing the current password and a new password.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
current_password (string): The user's current password.
\npassword (string): The new password.
\nCreates a new user within the organization. If the user does not have a password, a random password is generated and sent to the user via email.
\nRequest Parameters:
This endpoint requires a JSON body with the following field:
Removes a user from the organization. The user will be detached from the specified organization but not deleted from the system if they belong to multiple organizations.
\nRequest Parameters:
This endpoint requires a JSON body with the following field:
Updates the role of a user within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
email (string): The email address of the user whose role is to be updated.
\nrole (string): The new role to be assigned to the user.
\nAvailable Roles
\nREAD
MODIFY
EXECUTE
MANAGE
SUPER
Retrieve a list of available roles within the system.
\nRequest Parameters:
This endpoint does not require any query parameters.
Available Roles
\nREAD
MODIFY
EXECUTE
MANAGE
SUPER
Retrieve a paginated list of prefixes associated with the organization. This endpoint allows for filtering prefixes based on a search term.
\nRequest Parameters:
\n(optional, integer): The number of prefixes to return per page. Default is 10.
\n","type":"text/plain"},"key":"size","value":"10"},{"disabled":true,"description":{"content":"(optional, integer): The page number to retrieve. Default is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"(optional, string): A search term to filter prefixes by their name.
\n","type":"text/plain"},"key":"s","value":"PROJECT"}],"variable":[]}},"response":[{"id":"9c8f8954-d80d-4411-94fb-0159a7de8c11","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM","type":"text"}],"url":{"raw":"https://api.superclouds.ooo/v1/prefixes?size=10&page=1&s=PROJECT","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","prefixes"],"query":[{"key":"size","value":"10"},{"key":"page","value":"1"},{"key":"s","value":"PROJECT"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"super_id\": \"4bfec645-3d18-4f65-832d-8d54c93f6f5a\",\n \"name\": \"PROJECT1\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n },\n {\n \"super_id\": \"a9c350d7-7013-4939-8e44-98f7ae4178d1\",\n \"name\": \"PROJECT2\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n },\n {\n \"super_id\": \"cd4dc879-7aa7-4fc7-b75c-c3a707bfcd10\",\n \"name\": \"PROJECT3\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n }\n ],\n \"message\": \"successfully fetched all prefix\",\n \"page\": 1,\n \"pages\": 1,\n \"size\": 3,\n \"status\": 1,\n \"total\": 3\n}"}],"_postman_id":"b3c31ea1-572c-4a67-b7bd-2a6020e426dc"},{"name":"Prefixes by User","id":"aa0fdfce-f392-4d4d-9144-36fbc6935ee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.superclouds.ooo/v1/user/prefixes?uid={{user_id}}","description":"Retrieve a list of prefixes associated with a specific user within the organization. If no user ID is provided, the prefixes of the authenticated user will be returned.
\nRequest Parameters:
This endpoint does not require any query parameters, but can use a path parameter to specify a user ID.
(optional) Id of user, if did not give this value then it will take logged in user.
\n","type":"text/plain"},"key":"uid","value":"{{user_id}}"}],"variable":[]}},"response":[{"id":"d161e7ff-8b47-41db-9a9a-bd938796d506","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM","type":"text"}],"url":{"raw":"https://api.superclouds.ooo/v1/user/prefixes?uid={{user_id}}","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","user","prefixes"],"query":[{"key":"uid","value":"{{user_id}}","description":"(optional) Id of user, if did not give this value then it will take logged in user."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"super_id\": \"4bfec645-3d18-4f65-832d-8d54c93f6f5a\",\n \"name\": \"PROJECT1\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n },\n {\n \"super_id\": \"cd4dc879-7aa7-4fc7-b75c-c3a707bfcd10\",\n \"name\": \"PROJECT3\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n }\n ],\n \"message\": \"successfully fetched all prefix\",\n \"page\": 1,\n \"pages\": 1,\n \"size\": 3,\n \"status\": 1,\n \"total\": 3\n}"}],"_postman_id":"aa0fdfce-f392-4d4d-9144-36fbc6935ee7"},{"name":"Prefix","id":"07e63cb0-fedf-4db1-9d8a-cb98dba2953f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.superclouds.ooo/v1/prefixes/{{prefix_super_id}}","description":"Retrieve details of a specific prefix by its unique identifier.
\nRequest Parameters:
This endpoint requires a path parameter:
Creates a new prefix within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following field:
Updates the details of an existing prefix within the organization.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body:
super_id (string): The unique identifier of the prefix to be updated.
\nname (string): The new name for the prefix.
\nDeletes a specific prefix within the organization. A prefix can only be deleted if it is not being used by any services.
\nRequest Parameters:
This endpoint requires a path parameter:
Retrieve a list of users attached to a specific prefix within the organization. Optionally, filter by role.
\nRequest Parameters:
\nsuper-id (optional, string): The unique identifier of the prefix.
\nrole (optional, string): The role of the users to filter by.
\nAttaches a specified prefix to multiple users within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
prefix_role (object): The prefix role object containing:
\nsuper_id (string): The unique identifier of the prefix.
\nrole (string): The role to be assigned to the users for this prefix.
\nusers (array): An array of user identifiers to attach the prefix to.
\nAttaches multiple prefixes to a specific user within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
user_id (string): The unique identifier of the user to attach the prefixes to.
\nprefixes (array): An array of prefix role objects to be attached to the user.
\nsuper_id (string): The unique identifier of the prefix.
\nrole (string): The role to be assigned to the user for this prefix.
\nDetaches a specified prefix from multiple users within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
super_id (string): The unique identifier of the prefix to be detached.
\nusers (array): An array of user identifiers from whom the prefix will be detached.
\nDetaches multiple prefixes from a specific user within the organization.
\nRequest Parameters:
This endpoint requires a JSON body with the following fields:
user_id (string): The unique identifier of the user from whom the prefixes will be detached.
\nsuper_ids (array): An array of prefix identifiers to be detached from the user.
\nPrefixes are special labels attahed to a Organization.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4557d88f-c152-44b7-abf9-b011db99b1d8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"1095231d-10a1-4d1f-b4cd-162fb1b441a2","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"63c809ad-e3be-447e-bc7c-a0a0ef9782df"},{"name":"Services","item":[{"name":"List Services","id":"53547ac5-9e3e-4324-8f6e-e3b0630c49c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.superclouds.ooo/v1/services","description":"Retrieve a list of services associated with the organization, along with their prefixes.
\nRequest Parameters:
This endpoint does not require any query parameters.
Retrieve a filtered list of services associated with the organization, along with their prefixes. Supports both basic and detailed results.
\nRequest Parameters:
This endpoint requires a JSON body to specify filters, and supports optional query parameters:
filters (array): An array of filter objects.
\nfield (string): The field to filter by.
\noperator (string): The filter operator (e.g., \"in\").
\nterms (array): An array of terms to filter the field by.
\nsize (optional, integer): The number of services to return per page. Default is 10.
\npage (optional, integer): The page number to retrieve. Default is 0.
\nresult (optional, string): The result type (\"basic\" or \"detail\"). Default is \"basic\".
\n(optional, string): The result type (\"basic\" or \"detail\"). Default is \"basic\".
\n","type":"text/plain"},"key":"result","value":"detail"}],"variable":[]}},"response":[{"id":"217c5db0-5123-4c00-a09f-6c1e10226d0d","name":"200-Detailed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n {\n \"field\": \"type\",\n \"operator\": \"in\",\n \"terms\": [\n \"super-drive\"\n ]\n },\n {\n \"field\": \"prefix.super_id\",\n \"operator\": \"in\",\n \"terms\": [\n \"4bfec645-3d18-4f65-832d-8d54c93f6f5a\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.superclouds.ooo/v1/services?result=detail","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","services"],"query":[{"key":"result","value":"detail","description":"(optional, string): The result type (\"basic\" or \"detail\"). Default is \"basic\"."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"message\": \"List of services\",\n \"data\": [\n {\n \"prefixes\": [\n {\n \"super_id\": \"4bfec645-3d18-4f65-832d-8d54c93f6f5a\",\n \"name\": \"PROJECT1\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n }\n ],\n \"super_id\": \"234cb566-c609-4f43-a6b7-6357a1e96a37\",\n \"type\": \"super-drive\"\n },\n {\n \"prefixes\": [\n {\n \"super_id\": \"4bfec645-3d18-4f65-832d-8d54c93f6f5a\",\n \"name\": \"PROJECT1\",\n \"org_id\": \"617d2d899b510a4b4b21a1d9\"\n }\n ],\n \"super_id\": \"b2578cd8-041c-43e0-9705-7b332661d39b\",\n \"type\": \"super-drive\"\n }\n ],\n \"errors\": null\n}"},{"id":"402b6404-5a3f-4654-9b3b-f190dbc3257f","name":"200-Basic","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n {\n \"field\": \"type\",\n \"operator\": \"in\",\n \"terms\": [\n \"super-drive\"\n ]\n },\n {\n \"field\": \"prefix.super_id\",\n \"operator\": \"in\",\n \"terms\": [\n \"23e6d503-d852-47ed-870b-c1ad158f0d28\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.superclouds.ooo/v1/services","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","services"],"query":[{"key":"result","value":"detail","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"message\": \"List of services\",\n \"data\": [\n {\n \"prefix\": {\n \"super_id\": \"23e6d503-d852-47ed-870b-c1ad158f0d28\"\n },\n \"super_id\": \"c0acb976-e359-4d5c-9c2f-6372faac974a\",\n \"type\": \"super-drive\"\n },\n {\n \"prefix\": {\n \"super_id\": \"23e6d503-d852-47ed-870b-c1ad158f0d28\"\n },\n \"super_id\": \"b5cd7059-b4e8-411f-9cf1-2734429733e8\",\n \"type\": \"super-drive\"\n },\n {\n \"prefix\": {\n \"super_id\": \"23e6d503-d852-47ed-870b-c1ad158f0d28\"\n },\n \"super_id\": \"2cef7f1a-cb32-4dca-98a8-e19093f5d4ab\",\n \"type\": \"super-drive\"\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"798a0802-b772-4b4a-b312-38f29e57d046"},{"name":"Validate Prefixed Linked Services By SuperIds","id":"79a75e2d-0f73-4ca5-aece-f19d511d4199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"super_ids\": [\n \"bc3671ce-3dad-4f87-b90b-762478c7de5f\",\n \"5850f8eb-92a5-4058-ba9f-6fbb4be54f50\",\n \"e5e4b318-d3ca-42dd-b0e3-6f3d3b863dd6\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.superclouds.ooo/v1/validate/prefix/{{prefix_super_id}}/services","description":"Validates the services linked to a specified prefix by their Super IDs. Supports both basic and detailed views.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body, with an optional query parameter:
prefix_super_id (string): The unique identifier of the prefix.
\nsuper_ids (array): An array of service Super IDs to be validated.
\nview (optional, string): The view type (\"basic\" or \"detail\"). Default is \"basic\".
\nRetrieve details of a specific service by its unique identifier, including the prefixes associated with it.
\nRequest Parameters:
This endpoint requires a path parameter:
Update the details of a specific service by its unique identifier, including its associated prefixes.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body:
super_id (string): The unique identifier of the service to be updated.
\nprefix_ids (array): An array of prefix identifiers to be associated with the service.
\nRetrieve the details of a specific service by its unique identifier within a specified prefix.
\nRequest Parameters:
This endpoint requires path parameters:
prefix_super_id (string): The unique identifier of the prefix.
\nsuper_id (string): The unique identifier of the service.
\nCreate a new service under a specified prefix.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body:
super-machine and super-driveDelete a specific service by its unique identifier within a specified prefix.
\nRequest Parameters:
This endpoint requires path parameters:
prefix_super_id (string): The unique identifier of the prefix.
\nsuper_id (string): The unique identifier of the service.
\nRetrieve a paginated list of boxes within the specified prefix, filtered by provided criteria.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body, with optional query parameters for pagination:
Request Body:
The body should be a JSON object with the following fields:
super_ids (array): An array of box super IDs to be included in the results.
\nfilters (array, optional): An array of filter objects to narrow down the results.
\nfield (string): The field to filter by.
\noperator (string): The filter operator (e.g., \"nin\").
\nterms (array): An array of terms to filter the field by.
\nQuery Parameters:
\nsize (optional, integer): The number of boxes to return per page. Default is 10.
\npage (optional, integer): The page number to retrieve. Default is 0.
\nCreate a new box within the specified prefix.
\nRequest Parameters:
This endpoint requires a path parameter and a JSON body:
Request Body:
The body should be a JSON object with the following fields:
Retrieve the details of a specific box by its unique identifier within the specified prefix.
\nRequest Parameters:
This endpoint requires path parameters:
prefix (string): The prefix within which the box is located.
\nsuper_id (string): The unique identifier of the box.
\nRetrieve the total used size of a specific box within a specified date range.
\nRequest Parameters:
This endpoint requires path parameters and query parameters:
prefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nstart_date (string): The start date of the range in YYYY-MM-DD format.
end_date (string): The end date of the range in YYYY-MM-DD format.
The start date of the range in YYYY-MM-DD format.
\n","type":"text/plain"},"key":"start_date","value":"2024-04-01"},{"disabled":true,"description":{"content":"The end date of the range in YYYY-MM-DD format.
\n","type":"text/plain"},"key":"end_date","value":"2024-04-15"}],"variable":[]}},"response":[{"id":"d854c1a6-3a8f-4bca-97a7-022cb87ad10b","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsI....alWkxyMM"}],"url":{"raw":"https://api.superclouds.ooo/v1/super-drives/services/{{prefix_super_id}}/box/{{box_super_id}}/size","protocol":"https","host":["api","superclouds","ooo"],"path":["v1","super-drives","services","{{prefix_super_id}}","box","{{box_super_id}}","size"],"query":[{"key":"start_date","value":"2024-04-01","disabled":true},{"key":"end_date","value":"2024-04-15","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"message\": \"Total used size calculated successfully\",\n \"data\": {\n \"totalSize\": 427353332\n },\n \"errors\": null\n}"}],"_postman_id":"d64fa8a1-9b55-4f32-945e-576ab463c35d"},{"name":"Update Box Details","id":"6c764417-97a1-4638-b660-9ed29fca4bd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"name\": \"Rename My Box\"}","options":{"raw":{"language":"json"}}},"url":"https://api.superclouds.ooo/v1/super-drives/services/{{prefix_super_id}}/box/{{box_super_id}}","description":"Update the details of a specific box by its unique identifier within the specified prefix.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body:
prefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nRequest Body:
The body should be a JSON object with the fields to be updated:
Move a specific box to the trash by setting its is_deleted status to true and updating the deleted_at timestamp.
Request Parameters:
This endpoint requires path parameters:
Restore a specific box from the trash by setting its is_deleted status to false and updating the updated_at timestamp.
Request Parameters:
This endpoint requires path parameters:
prefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nPermanently delete a specific box by its unique identifier within the specified prefix.
\nRequest Parameters:
This endpoint requires path parameters:
prefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nRetrieve the contents of a specific folder within a box, including files and direct child folders.
\nRequest Parameters:
This endpoint requires path parameters and supports query parameters:
Path Parameters:
\nQuery Parameters:
\nRetrieve the list of folders within a specified box.
\nRequest Parameters:
This endpoint requires path parameters and supports query parameters:
Path Parameters:
\nprefix (string): The prefix within which the box is located.
\nsuper_id (string): The unique identifier of the box.
\nQuery Parameters:
\nCreate a new folder within the specified box. Supports creating nested folders.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nRequest Body:
\nMove a folder within the specified box to a new location.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nRequest Body:
\n\"replace\", \"rename\", and \"skip\". Defaults to \"skip\".Copy a folder within the specified box to a new location.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nprefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nRequest Body:
\n\"replace\", \"rename\", and \"skip\". Defaults to \"skip\".Move multiple folders within the specified box to new locations.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nprefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nRequest Body:
\n\"replace\", \"rename\", and \"skip\". Defaults to \"skip\".Copy multiple folders within the specified box to new locations.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nprefix_super_id (string): The prefix within which the box is located.
\nbox_super_id (string): The unique identifier of the box.
\nRequest Body:
\n\"replace\", \"rename\", and \"skip\". Defaults to \"skip\".This endpoint allows users to publish specified folders and their contents (including subfolders and files) within a box, making them accessible to the public.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nRequest Body:
\nThis endpoint allows users to unpublish specified folders and their contents (including subfolders and files) within a box, making them private.
\nRequest Parameters:
This endpoint requires path parameters and a JSON body.
Path Parameters:
\nRequest Body:
\nis_recursive (boolean): If true, the specified folders and all their subfolders and files will be unpublished. If false, only the specified folders and their direct files will be unpublished.
\nfolders (array of strings): An array of folder paths to be unpublished.
\nThis endpoint allows users to move specified folders and their contents (including subfolders and files) within a box to the trash.
\nRequest Parameters:
This endpoint requires URL parameters and a JSON body.
URL Parameters:
\nRequest Body:
\nThis endpoint allows users to move specified folders and their contents (including subfolders and files) within a box to the trash.
\nRequest Parameters:
This endpoint requires URL parameters and a JSON body.
URL Parameters:
\nRequest Body:
\nThis endpoint allows users to permanently delete specified folders and their contents (including subfolders and files) within a box that are marked as deleted.
\nRequest Parameters:
This endpoint requires URL parameters and a JSON body.
URL Parameters:
\nprefix_super_id (string): The unique identifier of the prefix.
\nbox_super_id (string): The unique identifier of the box.
\nRequest Body:
\nThis endpoint generates a URL for uploading a file to a specified box and folder. The URL is valid for a specified duration.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
super_id (string): The super ID of the box.
Request Body:
\npath (string): Path where the file will be uploaded.
name (string): Name of the file.
size (integer): Size of the file in bytes.
content_type (string): MIME type of the file.
This endpoint allows users to upload a file using a pre-signed upload URL. The URL is valid for a specified duration and can be used only once.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
url_id (string): The unique ID of the upload request.
Request Body:
\nfile (file): The file to be uploaded.This endpoint allows users to move or copy files from one folder to another within a box.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
super_id (string): The unique ID of the box.
Query Parameters:
\nmode (string, optional): Specifies the action type, either mv (move, default) or cp (copy).Request Body:
\nrequest_type (string): Specifies the type of request, either move or copy.
if_conflict (string): Specifies the action to take if a conflict occurs, can be \"skip\", \"replace\", or \"rename\". Defaults to \"rename\".
path (string): The source folder path.
destination_path (string): The destination folder path.
box_id (string): The unique ID of the box.
files (array of objects): List of files to be moved or copied. Each file object should include details like name, size, type, etc.
This endpoint allows users to rename a file within a specified folder in a box.
\nRequest Parameters:
\nPath Parameters:
\nprefix_super_id (string): The prefix associated with the service.
\nbox_super_id (string): The unique ID of the box.
\nRequest Body:
\npath (string): The folder path where the file is located.name (string): The current name of the file.new_name (string): The new name for the file.This endpoint allows users to publish files within a specified folder in a box.
\nRequest Parameters:
\nPath Parameters:
\nRequest Body:
\npath (string): The folder path where the files are located.files (array of objects): A list of files to be published. Each file object should contain:name (string): The name of the file.This endpoint allows users to unpublish files within a specified folder in a box.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
super_id (string): The unique ID of the box.
Request Body:
\npath (string): The folder path where the files are located.
files (array of objects): A list of files to be unpublished. Each file object should contain:
name (string): The name of the file.This endpoint allows users to move files within a specified folder in a box to trash.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
super_id (string): The unique ID of the box.
Request Body:
\npath (string): The folder path where the files are located.
files (array of objects): A list of files to be moved to trash. Each file object should contain:
name (string): The name of the file.This endpoint allows users to restore files from the trash within a specified folder in a box.
\nRequest Parameters:
\nPath Parameters:
\nprefix (string): The prefix associated with the service.
super_id (string): The unique ID of the box.
Request Body:
\nfiles (array of strings): A list of file paths to be restored.This endpoint allows users to permanently delete files from a specified folder in a box.
\nRequest Parameters:
\nprefix_super_id (string): The prefix associated with the service.box_super_id (string): The unique ID of the box.files (array of strings): A list of file paths to be permanently deleted.This endpoint retrieves a list of all available regions.
\nRequest Parameters:
This endpoint does not require any URL parameters or request body.