mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-07 21:46:42 +00:00
Update api docs
This commit is contained in:
@@ -36,7 +36,7 @@ YAML config can be applied using the API or from a Newt site. _Application throu
|
||||
|
||||
<Card title="API YAML">
|
||||
|
||||
You can also apply blueprints directly through the Pangolin API with an API key. [Take a look at the API documentation for more details.](https://api.pangolin.fossorial.io/v1/docs/#/Organization/put_org__orgId__blueprint)
|
||||
You can also apply blueprints directly through the Pangolin API with an API key. [Take a look at the API documentation for more details.](https://api.pangolin.net/v1/docs/#/Organization/put_org__orgId__blueprint)
|
||||
|
||||
POST to `/org/{orgId}/blueprint` with a base64 encodes JSON body like the following:
|
||||
|
||||
@@ -113,6 +113,9 @@ proxy-resources:
|
||||
auth:
|
||||
pincode: 123456
|
||||
password: your-secure-password
|
||||
basic-auth:
|
||||
user: asdfa
|
||||
password: sadf
|
||||
sso-enabled: true
|
||||
sso-roles:
|
||||
- Member
|
||||
@@ -283,6 +286,7 @@ Not allowed on TCP/UDP resources.
|
||||
|----------|------|----------|-------------|-------------|
|
||||
| `pincode` | number | No | 6-digit PIN for access | Must be exactly 6 digits |
|
||||
| `password` | string | No | Password for access | - |
|
||||
| `basic-auth` | object | No | Basic authentication configuration | Requires `user` and `password` fields |
|
||||
| `sso-enabled` | boolean | No | Enable SSO authentication | Defaults to `false` |
|
||||
| `sso-roles` | array | No | Allowed SSO roles | Cannot include "Admin" role |
|
||||
| `sso-users` | array | No | Allowed SSO user emails | Must be valid email addresses |
|
||||
|
||||
@@ -83,7 +83,7 @@ Root API keys have elevated permissions and should be used carefully. Only creat
|
||||
|
||||
## API Documentation
|
||||
|
||||
View the Swagger docs here: [https://api.pangolin.fossorial.io/v1/docs](https://api.pangolin.fossorial.io/v1/docs).
|
||||
View the Swagger docs here: [https://api.pangolin.net/v1/docs](https://api.pangolin.net/v1/docs).
|
||||
|
||||
Interactive API documentation is available through Swagger UI:
|
||||
|
||||
|
||||
@@ -83,7 +83,7 @@ Root API keys have elevated permissions and should be used carefully. Only creat
|
||||
|
||||
## API Documentation
|
||||
|
||||
View the Swagger docs here: [https://api.pangolin.fossorial.io/v1/docs](https://api.pangolin.fossorial.io/v1/docs).
|
||||
View the Swagger docs here: [https://api.pangolin.net/v1/docs](https://api.pangolin.net/v1/docs).
|
||||
|
||||
Interactive API documentation is available through Swagger UI:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user