NodeRingsDocs

Create Organization

POST
/v1/organizations

Authorization

Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Request Body

name?string
description?string
type?string
Default"ORGANIZATION_TYPE_UNSPECIFIED"
Value in"ORGANIZATION_TYPE_UNSPECIFIED" | "ORGANIZATION_TYPE_PROVIDER" | "ORGANIZATION_TYPE_CLIENT"
providerLogoUrl?string
asn?string
Formatint64
ddosProvider?string

DDoS partner slug (e.g. none, in-house, gcore, akamai, voxility). Provider orgs only.

hypervisorDriver?string

Ignored. Hypervisor driver is chosen when the first agent is registered, not at organization create. Must be unspecified for client organizations.

Default"PLATFORM_DRIVER_UNSPECIFIED"
Value in"PLATFORM_DRIVER_UNSPECIFIED" | "PLATFORM_DRIVER_PROXMOX" | "PLATFORM_DRIVER_VIRTFUSION" | "PLATFORM_DRIVER_SOLUSVM"
providerWebsiteUrl?string

Required for provider organizations (http/https; scheme optional in input: server normalizes).

Response Body

application/json

curl -X POST "https://api.noderings.com/v1/organizations" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}" \  -H "Content-Type: application/json" \  -d '{  "name": "string",  "description": "string",  "type": "ORGANIZATION_TYPE_UNSPECIFIED",  "providerLogoUrl": "string",  "asn": "string",  "ddosProvider": "string",  "hypervisorDriver": "PLATFORM_DRIVER_UNSPECIFIED",  "providerWebsiteUrl": "string"}'
{
  "success": true
}

Token POST

Token exchanges authorization code for access token

Delete Organization DELETE

Next Page