Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
/platform
The Platform endpoint focuses on the overall management of the opsnow.io service.
It encompasses a wide range of configuration tasks for the site, from user management to adjustments for various services.
User Management: Add, modify, or remove users and assign roles and permissions.
Service Settings:Configure and adjust settings related to the opsnow.io service.
Insights with Platform Analytics: Understand user interactions, platform usage, and other essential metrics.
Welcome to api.opsnow.io API Reference. Our API is built with the purpose of streamlining cloud operations and is categorized into three main sections: asset
, cost
, and platform
. Each of these endpoints is designed to offer developers a robust set of tools for seamless cloud management.
GET
getUserGET
listUserCompaniesGET
getServiceAccountGET
getAzureTenantGET
getAwsAccountGET
listGcpServiceAccountsGET
listGcpProjects_1GET
listAzureTenantsGET
listAzureSubscriptionsGET
listVendorsGET
listGcpProjectsGET
listAwsAccountsGET
getAwsAccountSavingsRecommendationGET
getAwsAccountSetupGET
listMasterCompaniesGET
listMasterCompanyUsersTo ensure optimal performance and fairness, we provide rate limits.
Standard users can make a maximum of 1000 requests per hour.
If more access is required, please contact us at contact@opsnow.io to upgrade your limits.
This document introduces the official API of opsnow.io
At opsnow.io, we're committed to simplifying the complexities of modern cloud infrastructure. Our CMP(Cloud Management Platform) stands at the forefront of this mission, providing unparalleled tools and insights for businesses.
Cost Savings: Explore complex cloud costs and find cost-saving opportunities.
Resource Management: Ensure visibility and control over cloud resources. Monitor and manage resources to optimize your cloud environment.
Intuitive API: This document guides developers through powerful APIs to provide integrations and automations for cloud management. With clear instructions and examples, developers can easily and quickly leverage all the features of the opsnow.io platform.
We're delighted to have you here, and we're confident that our platform will drive efficiency, clarity, and scalability for your cloud operations.
opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:
Indicates inaccurate or incomplete parameters.
Indicates that there is an error on the opsnow.io server.
opsnow.io also outputs error messages and error codes in JSON format.
This article describes the authentication method of opsnow.io's API.
All requests to the API require authentication.
opsnow.io uses a Bearer token for this purpose. Include the token in the request header as follows:
For security reasons, keep the access token confidential.
Avoid hardcoding it directly into the application or exposing it in client-side scripts.
opsnow.io issues an API key after the user authentication process during the login. Subsequently, you can obtain an access token to make API calls.
The requested user information is verified, and an API Key will be issued.
Using the API Key obtained in Step 1, request for access token issuance.
If the request for access token issuance is processed successfully, the access token and its expiration time (3600s) are returned.
With the access token obtained in Step 2, you can use opsnow.io's actual API.
The issued access token follows the Bearer token method, explicitly stating the Bearer string and transmitting the access token.
If the access token's validity period expires, access token reissuance is necessary.
code | description |
---|---|
code | description |
---|---|
Access the service and request the issuance of an API Key.
400
Bad Request: Used when the client's request is malformed or invalid.
401
Unauthorized: Used when the client is not authenticated or when the authentication token has expired.
404
Not Found: Used when the requested resource is not present on the server.
405
Method Not Allowed: Used when attempting to access a resource with an unsupported HTTP method.
429
Too Many Requests: Used when the client has sent too many requests within a given time frame, typically indicating exceeding request limits.
500
Internal Server Error: Used when an internal server error occurs. Specific details about the cause should be checked in the server logs.
503
Service Unavailable: Used when the server is temporarily unable to handle the request. This could occur, for example, when the server is overloaded or undergoing maintenance.
504
Gateway Timeout: Used when the server, acting as a gateway or proxy, did not receive a timely response from the upstream server.
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK