Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/apis/portal-api/http-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ Read the documentation on how to obtain your environment ID.
The API endpoint URL has the following format:

```
https://<api-name>-<environment-id>.platform.quix.io/<action>
https://<api-name>-<environment-id>.cloud.quix.io/<action>
```

So, for example, the endpoint URL for the streaming writer might resemble the following:
So, for example, the endpoint URL for the portal API might resemble the following:

```
https://writer-acme-weather.platform.quix.io/<action>
https://reader-demo-project-env.cloud.quix.io/<action>
```

The API is `writer`, and the environment ID is `acme-weather`.
Note that the Portal API is not bound to environment and therefore doesn't require an environment ID in the URL.

## HTTP method

Expand Down Expand Up @@ -81,5 +81,5 @@ You should structure most of your requests to the API around this pattern:
curl -H "Authorization: bearer ${token}" \
-H "Content-Type: application/json" \
-d "@data.json" \
https://${api-name}-${environment-id}.platform.quix.io/<action>
https://${api-name}-${environment-id}.cloud.quix.io/<action>
```
8 changes: 3 additions & 5 deletions docs/apis/portal-api/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener

## Get environment ID

When using APIs youll need to obtain an ID based on a specific environment. For example, endpoints for the [Query API](../../apis/query-api/overview.md) use a domain with the following pattern:
When using APIs you'll need to obtain an ID based on a specific environment. For example, endpoints for environment-specific APIs use a domain with the following pattern:

https://telemetry-query-${environment-id}.platform.quix.io/
https://<api-name>-${environment-id}.cloud.quix.io/

The environment ID is a combination of your organization and environment names, converted to URL friendly values.

Expand Down Expand Up @@ -101,10 +101,8 @@ The URLs for the API references are specific to your environment, so you can eas

| API | API reference URL (Swagger documentation)|
|---|---|
| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
| Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
| Portal | https://portal-api.platform.quix.io/swagger |
| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
| Portal | https://portal-api.cloud.quix.io/swagger |

Replace `<environment-id>` with your environment ID.

Expand Down
79 changes: 0 additions & 79 deletions docs/apis/query-api/aggregate-tags.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/apis/query-api/aggregate-time.md

This file was deleted.

82 changes: 0 additions & 82 deletions docs/apis/query-api/filter-tags.md

This file was deleted.

83 changes: 0 additions & 83 deletions docs/apis/query-api/http-requests.md

This file was deleted.

Binary file removed docs/apis/query-api/images/apis-tokens.png
Binary file not shown.
30 changes: 0 additions & 30 deletions docs/apis/query-api/overview.md

This file was deleted.

Loading