Skip to main content

Work with OpenAPI endpoint definition files

OpenAPI is a standard method of defining REST endpoints. You can import the OpenAPI into your favorite REST tool to explore the endpoints and execute calls. Postman is one of several possible REST tools that can be used for this purpose.

To work with OpenAPI endpoint definition files in Postman:

  1. On the Postman Import dialog, paste the URL of the JSON file which defines the Snow Atlas API. This URL can be copied from the table below.

    APIURL
    SAM Agreementshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/agreements.json
    SAM Applicationshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/applications.json
    SAM Computershttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/computers.json
    SAM Custom objectshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/customobjects.json
    SAM Datacenters/Clustershttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/dcc.json
    SAM Licenseshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/licenses.json
    SAM Mobile deviceshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/mobiledevices.json
    SAM Oraclehttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/oracle.json
    SAM User accountshttps://raw.githubusercontent.com/SnowSoftwareGlobal/snowatlas-integrations/main/api_specifications/useraccounts.json
    Cloud Connectorshttps://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/meta/http
    Cloud Billing datahttps://{region}.snowsoftware.io/api/cloud-visibility/normalized-billing-data/v1/meta/http
    Cloud License Management resourceshttps://{region}.snowsoftware.io/api/cloud-license-management/cloud-licensing-data/v1/meta/http
    note

    You can find your Data region for {region} in the Snow Atlas settings menu, in Licenses and usage. Your Data region is on the General information tab. For more information, see General information.

  2. Use the Postman Documentation tab to visually preview each API endpoint definition. Examples are displayed for how to integrate different programming languages.

  3. A Postman collection was created as part of the Postman import. This collection can be used to execute REST calls directly from Postman.

Snow Software does not own the third party trademarks, software, products, or tools (collectively, the "Third Party Products") referenced herein. Third Party Product updates, including user interface updates, may not be reflected in this content.