Every endpoint a customer or partner organisation can call. Endpoints reserved for Vigilbase staff aren't listed. Each page shows the host it's on:
- v1 operations on
https://api.vigilbase.com/one/v1, from One's API contract. Their titles, descriptions and response fields are declared, lists use cursor pagination and errors are problem details. Each page also names the operation's older path onhttps://one.vigilbase.com/api: a deprecated alias that still answers for now, and will be retired with410 Gone. New scripts should use the v1 path. Their OpenAPI document is athttps://api.vigilbase.com/one/v1/openapi.json. - Every other endpoint on
https://one.vigilbase.com/api, generated from the API catalog One builds from its own route handlers.
Each page shows the permission the endpoint needs, whether it needs a recent sign-in, its parameters and body, and an example request. Sign-in, hosts, rate limits and error shapes are on Vigilbase One API; the area pages there explain the endpoints the CLI uses in more detail, by their v1 paths where they have one.
Try it from these pages
Each page has a Try it panel that sends the request from your browser to the host on that page, api.vigilbase.com/one/v1 or one.vigilbase.com. One sign-in works on both:
Click Try it, then Sign in with Vigilbase. A Vigilbase sign-in window opens. If you belong to more than one organisation, choose the one the requests are for.
Fill in the request. Path and query parameters and the JSON body start from the page's example.
Click Send. Requests that can change data (
POST,PUT,PATCHandDELETE) ask you to confirm first. The response shows its status, time, headers and body.
Requests act as you in the organisation you chose, with your role's permissions, exactly as from the CLI. The page renews the token in the background and hands it to the next docs page you open in the same tab, so you stay signed in across pages until you sign out, close the tab, or your Vigilbase session ends. Other tabs sign in separately, and nothing is saved beyond the tab.
The docs can't send changes that need a recent sign-in or file uploads; One refuses them from the docs, and their pages say so. Use the CLI or the cURL example for those. To run a request in a terminal instead, copy it with Copy cURL and set VIGILBASE_TOKEN to an Identity access token (see Sign in and send the token), or use the CLI command shown where there is one.
The v1 operations' titles are their declared summaries. The other endpoints' titles come from their method and path, and many have no written description yet; their pages show only what the catalog records.
Account
| Endpoint | Method and path |
|---|---|
| Get account | GET/api/account |
| Get account billing | GET/api/account/billing |
| List account Cloudflare zones | GET/api/account/cloudflare/zones |
| List account endpoints | GET/api/account/endpoints |
| Get account organization | GET/api/account/organization |
| List account services | GET/api/account/services |
| List account Watchdog targets | GET/api/account/watchdog/targets |
Activities
| Endpoint | Method and path |
|---|---|
| List activities | GET/api/activities |
Billing
| Endpoint | Method and path |
|---|---|
| Get billing | GET/customers/{customerId}/billing |
| List invoices | GET/customers/{customerId}/invoices |
| List subscriptions | GET/customers/{customerId}/subscriptions |
| Get bandwidth usage for customer | GET/api/billing/bandwidth/usage |
| Create billing portal | POST/api/billing/portal |
| Create billing setup intent | POST/api/billing/setup-intent |
Change requests
| Endpoint | Method and path |
|---|---|
| List change requests | GET/change-requests |
| Request a change | POST/change-requests |
| Get a change request | GET/api/change-requests/{id} |
| Create a change request action | POST/api/change-requests/{id}/actions |
| Preview a change request | POST/api/change-requests/preview |
| Submit a change request | POST/api/change-requests/submit |
Cloudflare
| Endpoint | Method and path |
|---|---|
| List a customer’s Cloudflare zones | GET/customers/{customerId}/cloudflare-zones |
| List a zone’s DNS records | GET/cloudflare/zones/{zoneId}/dns-records |
| Get a zone’s security settings | GET/cloudflare/zones/{zoneId}/security |
| Get Cloudflare Checkup status | GET/cloudflare/checkups |
| Get a Cloudflare account | GET/api/cloudflare/accounts/{accountId} |
| Get Cloudflare account audit logs | GET/api/cloudflare/accounts/{accountId}/audit-logs |
| List Cloudflare account tokens | GET/api/cloudflare/accounts/{accountId}/tokens |
| List Cloudflare account zones | GET/api/cloudflare/accounts/{accountId}/zones |
| Deploy Cloudflare | POST/api/cloudflare/deploy |
| Provision Cloudflare | POST/api/cloudflare/provision |
| Purge a Cloudflare zone's cache | POST/api/cloudflare/zones/{zoneId}/cache |
Contracts
| Endpoint | Method and path |
|---|---|
| List contracts | GET/customers/{customerId}/contracts |
| Get a contract | GET/customers/{customerId}/contracts/{contractId} |
| List contract usage alerts | GET/customers/{customerId}/usage-alerts |
Customer projects
| Endpoint | Method and path |
|---|---|
| List customer projects | GET/api/customer-projects |
Customers
| Endpoint | Method and path |
|---|---|
| List customers | GET/customers |
| Get a customer | GET/customers/{customerId} |
| List a customer’s contacts | GET/customers/{customerId}/contacts |
| Get a customer’s login organisation | GET/customers/{customerId}/organization |
| List a customer’s services | GET/customers/{customerId}/services |
| List a customer’s endpoints | GET/customers/{customerId}/endpoints |
| List a customer’s monitoring incidents | GET/customers/{customerId}/incidents |
| Acknowledge a monitoring incident | POST/customers/{customerId}/incidents/{incidentId}/acknowledge |
| Create a customer | POST/api/customers |
| Get a customer | GET/api/customers/{id} |
| Replace a customer | PUT/api/customers/{id} |
| Delete a customer | DEL/api/customers/{id} |
| Get customer afi.ai audit | GET/api/customers/{id}/afi/audit |
| List customer afi.ai tenants | GET/api/customers/{id}/afi/tenants |
| Get customer afi.ai usage | GET/api/customers/{id}/afi/usage |
| Get customer Auth0 org | GET/api/customers/{id}/auth0-org |
| Replace customer billing | PUT/api/customers/{id}/billing |
| Get customer change policy | GET/api/customers/{id}/change-policy |
| Replace customer change policy | PUT/api/customers/{id}/change-policy |
| List all Cloudflare accounts for a customer with metadata | GET/api/customers/{id}/cloudflare/accounts |
| Link a new Cloudflare account to a customer | POST/api/customers/{id}/cloudflare/accounts |
| Unlink a specific Cloudflare account from a customer | DEL/api/customers/{id}/cloudflare/accounts |
| Replace Cloudflare account credential | PUT/api/customers/{id}/cloudflare/accounts/credential |
| Get customer Cloudflare credentials | GET/api/customers/{id}/cloudflare/credentials |
| List Cloudflare credentials accounts | GET/api/customers/{id}/cloudflare/credentials/{credentialId}/accounts |
| Get a customer Cloudflare zone | GET/api/customers/{id}/cloudflare/zones/{zoneId} |
| Create a customer contract | POST/api/customers/{id}/contracts |
| Replace a customer contract | PUT/api/customers/{id}/contracts/{contractId} |
| Delete a customer contract | DEL/api/customers/{id}/contracts/{contractId} |
| List contract attachments | GET/api/customers/{id}/contracts/{contractId}/attachments |
| Upload a contract attachment | POST/api/customers/{id}/contracts/{contractId}/attachments |
| Get a contract attachment | GET/api/customers/{id}/contracts/{contractId}/attachments/{attachmentId} |
| Delete a contract attachment | DEL/api/customers/{id}/contracts/{contractId}/attachments/{attachmentId} |
| List contract available services | GET/api/customers/{id}/contracts/{contractId}/available-services |
| Get contract billing check | GET/api/customers/{id}/contracts/{contractId}/billing-check |
| Get contract Common Paper status | GET/api/customers/{id}/contracts/{contractId}/commonpaper/status |
| List contract invoices | GET/api/customers/{id}/contracts/{contractId}/invoices |
| Create a contract invoice | POST/api/customers/{id}/contracts/{contractId}/invoices |
| Delete a contract invoice | DEL/api/customers/{id}/contracts/{contractId}/invoices/{invoiceId} |
| List contract line items | GET/api/customers/{id}/contracts/{contractId}/line-items |
| Create a contract line item | POST/api/customers/{id}/contracts/{contractId}/line-items |
| Replace a contract line item | PUT/api/customers/{id}/contracts/{contractId}/line-items/{itemId} |
| Delete a contract line item | DEL/api/customers/{id}/contracts/{contractId}/line-items/{itemId} |
| Create a line item Stripe quantity | POST/api/customers/{id}/contracts/{contractId}/line-items/{itemId}/stripe-quantity |
| Get contract usage | GET/api/customers/{id}/contracts/{contractId}/usage |
| List customer contract invoices | GET/api/customers/{id}/contracts/invoices |
| Create a customer invoice | POST/api/customers/{id}/create-invoice |
| Sync endpoints for a customer's integrations | POST/api/customers/{id}/endpoints/sync |
| Get customer fabric | GET/api/customers/{id}/fabric |
| Sync Cloudflare zones as monitoring targets | POST/api/customers/{id}/monitoring/sync-cloudflare |
| Create a customer monitoring target | POST/api/customers/{id}/monitoring/targets |
| Get a customer monitoring target | GET/api/customers/{id}/monitoring/targets/{targetId} |
| Replace a customer monitoring target | PUT/api/customers/{id}/monitoring/targets/{targetId} |
| Delete a customer monitoring target | DEL/api/customers/{id}/monitoring/targets/{targetId} |
| Get customer overview | GET/api/customers/{id}/overview |
| List customer partner customers | GET/api/customers/{id}/partner-customers |
| List customer partner deals | GET/api/customers/{id}/partner-deals |
| List customer partner quarterly reviews | GET/api/customers/{id}/partner-quarterly-reviews |
| Create a customer partner quarterly review | POST/api/customers/{id}/partner-quarterly-reviews |
| Get customer Pylon | GET/api/customers/{id}/pylon |
| List customer Pylon contacts | GET/api/customers/{id}/pylon/contacts |
| List customer Pylon issues | GET/api/customers/{id}/pylon/issues |
| Get recon report PDF | GET/api/customers/{id}/recon/reports/{reportId}/pdf |
| Get a quarterly report | GET/api/customers/{id}/reports/quarterly/{qbrId} |
| Get a customer service | GET/api/customers/{id}/services/{serviceId} |
| List unlinked customer services | GET/api/customers/{id}/services/unlinked |
| List customer Stripe customers | GET/api/customers/{id}/stripe/customers |
| Create a customer Stripe customer | POST/api/customers/{id}/stripe/customers |
| Delete customer Stripe customers | DEL/api/customers/{id}/stripe/customers |
| Create Watchdog scan insights | POST/api/customers/{id}/watchdog/scans/{scanId}/insights |
| Get a customer Watchdog target | GET/api/customers/{id}/watchdog/targets/{targetId} |
| Replace a customer Watchdog target | PUT/api/customers/{id}/watchdog/targets/{targetId} |
| Delete a customer Watchdog target | DEL/api/customers/{id}/watchdog/targets/{targetId} |
| Clean up customers | POST/api/customers/cleanup |
| List existing customer services | GET/api/customers/existing-services |
| Get your customer | GET/api/customers/me |
Deployments
| Endpoint | Method and path |
|---|---|
| Start a deployment | POST/api/deployments/start |
Domain
| Endpoint | Method and path |
|---|---|
| Validate a domain | POST/api/domain/validate |
Exchange rates
| Endpoint | Method and path |
|---|---|
| List exchange rates | GET/api/exchange-rates |
Integrations
| Endpoint | Method and path |
|---|---|
| Sync integration Cloudflare | POST/api/integrations/cloudflare/sync |
Monitoring
| Endpoint | Method and path |
|---|---|
| List Watchdog targets | GET/customers/{customerId}/watchdog-targets |
| Add a Watchdog target | POST/customers/{customerId}/watchdog-targets |
| List Watchdog scans | GET/customers/{customerId}/watchdog-scans |
| Start a Watchdog scan | POST/customers/{customerId}/watchdog-scans |
| List monitoring targets | GET/customers/{customerId}/monitoring/targets |
| Get monitoring status | GET/customers/{customerId}/monitoring/status |
| Get monitoring history | GET/customers/{customerId}/monitoring/history |
| Get target metrics | GET/monitoring/metrics |
| List your Watchdog scans | GET/watchdog-scans |
| Create monitoring metrics | POST/api/monitoring/metrics |
Organization
| Endpoint | Method and path |
|---|---|
| Get organization identity SSO | GET/api/organization/identity/sso |
| Create organization identity SSO | POST/api/organization/identity/sso |
Organizations
| Endpoint | Method and path |
|---|---|
| Get organization client | GET/api/organizations/client |
Partner applications
| Endpoint | Method and path |
|---|---|
| Create a partner application agreement | POST/api/partner-applications/{id}/agreement |
Partners
| Endpoint | Method and path |
|---|---|
| Refresh partner brand | POST/api/partners/brand/refresh |
| Get partner Cloudflare credentials | GET/api/partners/cloudflare-credentials |
| Create partner Cloudflare credentials | POST/api/partners/cloudflare-credentials |
| Delete partner Cloudflare credentials | DEL/api/partners/cloudflare-credentials/{credentialId} |
| Get partner collateral | GET/api/partners/collateral |
| Get partner collateral PDF | GET/api/partners/collateral/{slug}/pdf |
| Preview a partner collateral | GET/api/partners/collateral/{slug}/preview |
| List partner contracts | GET/api/partners/contracts |
| List partner customers | GET/api/partners/customers |
| Get a partner customer | GET/api/partners/customers/{id} |
| List partner datasheets | GET/api/partners/datasheets |
| Download a partner datasheet | GET/api/partners/datasheets/{slug}/download |
| Get partner datasheet file | GET/api/partners/datasheets/{slug}/file |
| Preview a partner datasheet | GET/api/partners/datasheets/{slug}/preview |
| List partner datasheet links | GET/api/partners/datasheets/links |
| Create a partner datasheet link | POST/api/partners/datasheets/links |
| Get a partner datasheet link | GET/api/partners/datasheets/links/{id} |
| Update a partner datasheet link | PATCH/api/partners/datasheets/links/{id} |
| Delete a partner datasheet link | DEL/api/partners/datasheets/links/{id} |
| Get a partner deal | GET/api/partners/deals/{id} |
| List partner deal form options | GET/api/partners/deals/form-options |
| Get partner deal pipeline | GET/api/partners/deals/pipeline |
| Register a partner deal | POST/api/partners/deals/register |
| Analyze a partner domain | POST/api/partners/domain/analyze |
| Analyze a partner domain (streamed) | POST/api/partners/domain/analyze/stream |
| Create partner domain report | POST/api/partners/domain/report |
| Get partner logo | GET/api/partners/logo |
| Upload partner logo | POST/api/partners/logo |
| Delete partner logo | DEL/api/partners/logo |
| Get partner monitoring status | GET/api/partners/monitoring/status |
| List partner onboarding forms | GET/api/partners/onboarding-forms |
| Create a partner onboarding form | POST/api/partners/onboarding-forms |
| Get a partner onboarding form | GET/api/partners/onboarding-forms/{id} |
| Update a partner onboarding form | PATCH/api/partners/onboarding-forms/{id} |
| Delete a partner onboarding form | DEL/api/partners/onboarding-forms/{id} |
| Export a partner onboarding form | GET/api/partners/onboarding-forms/{id}/export |
| Get a partner onboarding form file | GET/api/partners/onboarding-forms/{id}/files/{fileId} |
| List partner onboarding form customers | GET/api/partners/onboarding-forms/customers |
| List partner quarterly reviews | GET/api/partners/quarterly-reviews |
| Create a partner quarterly review | POST/api/partners/quarterly-reviews |
| Get a partner quarterly review | GET/api/partners/quarterly-reviews/{id} |
| Update a partner quarterly review | PATCH/api/partners/quarterly-reviews/{id} |
| Create a partner quarterly review public link | POST/api/partners/quarterly-reviews/{id}/public-link |
| Delete partner quarterly review public link | DEL/api/partners/quarterly-reviews/{id}/public-link |
| List partner scoping sessions | GET/api/partners/scoping/sessions |
| Create a partner scoping session | POST/api/partners/scoping/sessions |
| Get a partner scoping session | GET/api/partners/scoping/sessions/{sessionId} |
| Update a partner scoping session | PATCH/api/partners/scoping/sessions/{sessionId} |
| Get partner settings | GET/api/partners/settings |
| Update partner settings | PATCH/api/partners/settings |
Qualification
| Endpoint | Method and path |
|---|---|
| Create qualification | POST/api/qualification |
Reports
| Endpoint | Method and path |
|---|---|
| List monthly security reports | GET/customers/{customerId}/recon-reports |
| Get a monthly security report | GET/customers/{customerId}/recon-reports/{reportId} |
| List reports | GET/customers/{customerId}/reports |
Services
| Endpoint | Method and path |
|---|---|
| Get Cloudflare account | GET/api/services/cloudflare/account |
| Get Cloudflare add-ons | GET/api/services/cloudflare/add-ons |
| Get Cloudflare aggregated | GET/api/services/cloudflare/aggregated |
| Get Cloudflare analytics | GET/api/services/cloudflare/analytics |
| Get Cloudflare analytics dashboard | GET/api/services/cloudflare/analytics/dashboard |
| List Cloudflare checkup accounts | GET/api/services/cloudflare/checkups/accounts |
| Analyze a Cloudflare checkup | POST/api/services/cloudflare/checkups/analyze |
| Create Cloudflare checkup credentials | POST/api/services/cloudflare/checkups/credentials |
| Delete Cloudflare checkup credentials | DEL/api/services/cloudflare/checkups/credentials |
| Get Cloudflare checkup progress | GET/api/services/cloudflare/checkups/progress |
| Get Cloudflare checkup report | GET/api/services/cloudflare/checkups/report |
| Start a Cloudflare checkup | POST/api/services/cloudflare/checkups/start |
| Get Cloudflare dashboard | GET/api/services/cloudflare/dashboard |
| List Cloudflare health checks | GET/api/services/cloudflare/health-checks |
| Get Cloudflare rule analyzer | GET/api/services/cloudflare/rule-analyzer |
| List Cloudflare users | GET/api/services/cloudflare/users |
| Get Cloudflare workspace | GET/api/services/cloudflare/workspace |
| Get a Cloudflare workspace section | GET/api/services/cloudflare/workspace/{section} |
| List Cloudflare zones | GET/api/services/cloudflare/zones |
| List Cloudflare zone bots | GET/api/services/cloudflare/zones/{zoneId}/bots |
| Get zone bot ja4 | GET/api/services/cloudflare/zones/{zoneId}/bots/ja4 |
| Create a DNS record | POST/api/services/cloudflare/zones/{zoneId}/dns |
| Update a DNS record | PATCH/api/services/cloudflare/zones/{zoneId}/dns |
| Delete a DNS record | DEL/api/services/cloudflare/zones/{zoneId}/dns |
| Replace a DNS record by ID | PUT/api/services/cloudflare/zones/{zoneId}/dns/{recordId} |
| Delete a DNS record by ID | DEL/api/services/cloudflare/zones/{zoneId}/dns/{recordId} |
| Change DNS records in a batch | POST/api/services/cloudflare/zones/{zoneId}/dns/batch |
| Import zone DNS analysis | POST/api/services/cloudflare/zones/{zoneId}/dns/import-analysis |
| Create a Cloudflare zone IP intel | POST/api/services/cloudflare/zones/{zoneId}/ip-intel |
| List Cloudflare zone lists | GET/api/services/cloudflare/zones/{zoneId}/lists |
| Replace Cloudflare zone security | PUT/api/services/cloudflare/zones/{zoneId}/security |
| List Cloudflare zone threats | GET/api/services/cloudflare/zones/{zoneId}/threats |
| Get Cloudflare zone WAF | GET/api/services/cloudflare/zones/{zoneId}/waf |
| List zone WAF hits | GET/api/services/cloudflare/zones/{zoneId}/waf/hits |
| Get zone WAF managed | GET/api/services/cloudflare/zones/{zoneId}/waf/managed |
| Get WAF rule traffic | GET/api/services/cloudflare/zones/{zoneId}/waf/rules/{ruleId}/traffic |
| Get NinjaOne | GET/api/services/ninja-one |
| Create NinjaOne | POST/api/services/ninja-one |
| Delete NinjaOne | DEL/api/services/ninja-one |
| List NinjaOne devices | GET/api/services/ninja-one/devices |
| List NinjaOne organizations | GET/api/services/ninja-one/organizations |
| Sync NinjaOne | POST/api/services/ninja-one/sync |
Stripe
| Endpoint | Method and path |
|---|---|
| Create a Stripe checkout session | POST/api/stripe/create-checkout-session |
| Get Stripe customer billing | GET/api/stripe/customer-billing |
| Delete a Stripe payment method | POST/api/stripe/payment-methods/delete |
| Set the default Stripe payment method | POST/api/stripe/payment-methods/set-default |
| Get Stripe pricing | GET/api/stripe/pricing |
| List Stripe products | GET/api/stripe/products |
| Get Stripe publishable key | GET/api/stripe/publishable-key |
| Get Stripe shield pricing | GET/api/stripe/shield-pricing |
Subscriptions
| Endpoint | Method and path |
|---|---|
| List subscriptions | GET/api/subscriptions |
| Get a subscription | GET/api/subscriptions/{id} |
| Create a subscription | POST/api/subscriptions/create |
Support
| Endpoint | Method and path |
|---|---|
| List support tickets | GET/support-tickets |
| Open a support ticket | POST/support-tickets |
| List a support ticket’s messages | GET/support-tickets/{ticketId}/messages |
| Reply to a support ticket | POST/support-tickets/{ticketId}/replies |
| Upload a support attachment | POST/api/support/attachments |
| Get a message attachment | GET/api/support/tickets/{issueId}/messages/{messageId}/attachments/{index} |
Tool runs
| Endpoint | Method and path |
|---|---|
| List tool runs | GET/tool-runs |
| Get a tool run | GET/tool-runs/{runId} |
| Get tool run brand | GET/api/tool-runs/{id}/brand |
| Claim tool runs | POST/api/tool-runs/claim |
Tools
| Endpoint | Method and path |
|---|---|
| Execute a tool | POST/api/tools/{toolName}/execute |
| Create an authenticated tool run stub | POST/api/tools/{toolName}/runs |
Training
| Endpoint | Method and path |
|---|---|
| Get training academy | GET/api/training/academy |
| Get your training | GET/api/training/me |
User
| Endpoint | Method and path |
|---|---|
| List user organizations | GET/api/user/organizations |
Vigil
| Endpoint | Method and path |
|---|---|
| List Vigil conversations | GET/api/vigil/conversations |
| Create a Vigil conversation | POST/api/vigil/conversations |
| List Vigil conversation approvals | GET/api/vigil/conversations/{conversationId}/approvals |
| Create a Vigil conversation approval | POST/api/vigil/conversations/{conversationId}/approvals |
| List Vigil conversation messages | GET/api/vigil/conversations/{conversationId}/messages |
| Create a Vigil conversation message | POST/api/vigil/conversations/{conversationId}/messages |
| List your Vigil conversations | GET/api/vigil/conversations/mine |