Create network

POST /networks
Bearer token

Creates a new network with the given name. The user automatically becomes a member of the network.

application/json

Body

  • network_name string Required

    The regex means: lowercase letters and numbers, separated by dashes, with no leading, trailing, or double dashes.

    Maximum length is 64. Format should match the following pattern: ^[a-z0-9](-?[a-z0-9])*$.

Responses

  • 201

    Created

    Hide response attribute Show response attribute object
    • network_identifier string

      Format should match the following pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$.
  • 400

    Bad Request

  • 401

    Unauthorized

  • 409

    Conflict

POST /networks 
curl \
 -X POST https://example.com/networks \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"network_name":"happy-un1c0rn"}'
Request example 
{
  "network_name": "happy-un1c0rn"
}
Request examples 
{
  "network_name": "happy-un1c0rn"
}
Response examples (201) 
{
  "network_identifier": "575a7328-4e2e-4b88-afcc-e0b5ed3920cc"
}
Response examples (201) 
{
  "network_identifier": "575a7328-4e2e-4b88-afcc-e0b5ed3920cc"
}