vantagedemo.apidocumentation.com Open in urlscan Pro
34.132.239.214  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Reference
Search ⌃k

 * Toggle group
   
   WORKSPACES
   
   * /workspaces
     
     get
   
   * /workspaces/{workspace_token}
     
     get
 * Toggle group
   
   FOLDERS

 * Toggle group
   
   FILTERS

 * Toggle group
   
   COSTS

 * Toggle group
   
   SEGMENTS

 * Toggle group
   
   DASHBOARDS

 * Toggle group
   
   TEAMS

 * Toggle group
   
   ACCESSGRANTS

 * Toggle group
   
   NOTIFICATIONS

 * Toggle group
   
   USERS

 * Toggle group
   
   PRICES

 * Toggle group
   
   PING

Dark Mode

2.0.0
OAS 2.0


VANTAGE

Download OpenAPI Spec

Vantage API

Base URL

https://api.vantage.sh/v2

Client Libraries


Shell
Ruby
Ruby

Node.js

PHP

Python

C
Libcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

More
Shell cURL


WORKSPACES # COPY LINK TO "WORKSPACES"

Operations about Workspaces

Endpoints

get/workspacesget/workspaces/{workspace_token}


/WORKSPACES # COPY LINK TO "/WORKSPACES"

Return all Workspaces that the current API token has access to.

Query Parameters
 * page
   
   The page of results to return.

 * limit
   
   The amount of results to return. The maximum is 1000.

Responses
 * 200

get/workspaces
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://api.vantage.sh/v2/workspaces
Test Request
200

No Body


/WORKSPACES/{WORKSPACE_TOKEN} # COPY LINK TO "/WORKSPACES/{WORKSPACE_TOKEN}"

Return a specific Workspace.

Path Parameters
 * workspace_token required

Responses
 * 200
 * 404
   
   NotFound

get/workspaces/{workspace_token}
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://api.vantage.sh/v2/workspaces/__WORKSPACE_TOKEN__
Test Request
200404

No Body


FOLDERS # COPY LINK TO "FOLDERS"

Operations about Folders

Endpoints

post/foldersget/foldersdelete/folders/{folder_token}put/folders/{folder_token}get/folders/{folder_token}
Show More


FILTERS # COPY LINK TO "FILTERS"

Operations about Filters

Endpoints

post/saved_filtersget/saved_filtersdelete/saved_filters/{saved_filter_token}put/saved_filters/{saved_filter_token}get/saved_filters/{saved_filter_token}
Show More


COSTS # COPY LINK TO "COSTS"

Operations about Costs

Endpoints

post/cost_reportsget/cost_reportsdelete/cost_reports/{cost_report_token}put/cost_reports/{cost_report_token}get/cost_reports/{cost_report_token}get/costs
Show More


SEGMENTS # COPY LINK TO "SEGMENTS"

Operations about Segments

Endpoints

post/segmentsget/segmentsdelete/segments/{segment_token}put/segments/{segment_token}get/segments/{segment_token}
Show More


DASHBOARDS # COPY LINK TO "DASHBOARDS"

Operations about Dashboards

Endpoints

post/dashboardsget/dashboardsdelete/dashboards/{dashboard_token}put/dashboards/{dashboard_token}get/dashboards/{dashboard_token}
Show More


TEAMS # COPY LINK TO "TEAMS"

Operations about Teams

Endpoints

post/teamsget/teamsdelete/teams/{team_token}put/teams/{team_token}get/teams/{team_token}
Show More


ACCESSGRANTS # COPY LINK TO "ACCESSGRANTS"

Operations about AccessGrants

Endpoints

post/access_grantsget/access_grantsdelete/access_grants/{access_grant_token}put/access_grants/{access_grant_token}get/access_grants/{access_grant_token}
Show More


NOTIFICATIONS # COPY LINK TO "NOTIFICATIONS"

Operations about Notifications

Endpoints

post/report_notificationsget/report_notificationsdelete/report_notifications/{report_notification_token}put/report_notifications/{report_notification_token}get/report_notifications/{report_notification_token}
Show More


USERS # COPY LINK TO "USERS"

Operations about Users

Endpoints

get/usersget/users/{user_token}
Show More


PRICES # COPY LINK TO "PRICES"

Operations about Prices

Endpoints

get/productsget/products/{id}get/products/{product_id}/pricesget/products/{product_id}/prices/{id}
Show More


PING # COPY LINK TO "PING"

Operations about Pings

Endpoints

get/ping


/PING # COPY LINK TO "/PING"

This is a health check endpoint that can be used to determine Vantage API
healthiness. It will return 200 if everything is running smoothly.

Responses
 * 200
   
   This is a health check endpoint that can be used to determine Vantage API
   healthiness. It will return 200 if everything is running smoothly.

get/ping
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://api.vantage.sh/v2/ping
Test Request
200

No Body

This is a health check endpoint that can be used to determine Vantage API
healthiness. It will return 200 if everything is running smoothly.

This documentation playground was created by Scalar. For help, questions or
feedback don't hesitate to email our support.


You can fully customize or delete this footer by simply navigating to the footer
section of the "customize" button within our header.


Features About Pricing
Privacy Policy Terms of Service Pricing


© 2023 Scalar