Skip to content

Commit

Permalink
docs: organizations to orgs (#6036)
Browse files Browse the repository at this point in the history
* docs: organizations to orgs

* fix: pr changes
  • Loading branch information
mindspank authored Nov 6, 2024
1 parent 1e6842b commit 683f9c8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/docs/integrate/custom-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ sidebar_position: 11
---

Rill exposes [custom APIs](/integrate/custom-apis/index.md) you have created under `apis` folder as HTTP endpoints
at `https://admin.rilldata.com/v1/organizations/<org-name>/projects/<project-name>/runtime/api/<api-name>`.
at `https://admin.rilldata.com/v1/orgs/<org-name>/projects/<project-name>/runtime/<path to api file>`.

## Accessing custom APIs
Custom APIs accepts both POST and GET requests to the API endpoint with a bearer token in the `Authorization` header.
For GET requests parameters can be passed in the url.

```bash
curl https://admin.rilldata.com/v1/orgs/<org-name>/projects/<project-name>/runtime/api/<api-name>[?query-args] \
curl https://admin.rilldata.com/v1/orgs/<org-name>/projects/<project-name>/runtime/<path to api file>[?query-args] \
-H "Authorization: Bearer <token>"
```

```bash
curl -X POST https://admin.rilldata.com/v1/orgs/<org-name>/projects/<project-name>/runtime/api/<api-name>[?query-args] \
curl -X POST https://admin.rilldata.com/v1/orgs/<org-name>/projects/<project-name>/runtime/<path to api file>[?query-args] \
-H "Authorization: Bearer <token>"
```

Expand Down

0 comments on commit 683f9c8

Please sign in to comment.