Update nxosnet settings
Enable or disable nxosnet for the in-scope organization, claim or change its handle, and set name visibility. Every field is optional.
Enabling requires a handle: supply handle in the same request if the
organization has not claimed one yet. Supports Nxos-On-Behalf-Of so a
broker can configure a customer org it holds an active LOA on.
curl --request PATCH \
--url https://api.nxos.io/v1/organizations/nxosnet \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"handle": "<string>",
"showOrganizationName": true
}
'import requests
url = "https://api.nxos.io/v1/organizations/nxosnet"
payload = {
"enabled": True,
"handle": "<string>",
"showOrganizationName": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, handle: '<string>', showOrganizationName: true})
};
fetch('https://api.nxos.io/v1/organizations/nxosnet', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nxos.io/v1/organizations/nxosnet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'handle' => '<string>',
'showOrganizationName' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nxos.io/v1/organizations/nxosnet"
payload := strings.NewReader("{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.nxos.io/v1/organizations/nxosnet")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations/nxosnet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}"
response = http.request(request)
puts response.read_body{
"object": "nxosnet_settings",
"enabled": true,
"handle": "acme",
"showOrganizationName": true
}{
"error": {
"code": "invalid_request",
"message": "The request body is malformed or missing required fields.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "missing_api_key",
"message": "No Authorization header provided.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "forbidden",
"message": "Your organization is not enabled for this action.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "quote_expired",
"message": "The quote has expired.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected server error occurred.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}Headers
Bearer token. Format: Bearer <api_key>
Unique key per logical operation. UUID v4 recommended. Max 255 characters.
Body
Request body for PATCH /v1/organizations/nxosnet. Every field is optional;
omitted fields are left unchanged. Supplying no fields is a 400.
Enable or disable receiving nxosnet transfers. Enabling requires a handle to already be set, or supplied in the same request.
Claim or change the organization's nxosnet handle. 3-32 chars: lowercase letters, digits, and non-leading/trailing/consecutive hyphens.
Show or hide the organization's name to senders resolving its handle.
Response
The request has succeeded.
nxosnet settings for an organization.
Always nxosnet_settings.
nxosnet_settings Whether this organization can receive nxosnet transfers. Requires a handle to be set.
The organization's globally-unique nxosnet handle, or null if none has been claimed yet.
Whether the organization's name is shown to senders who look up its handle.
curl --request PATCH \
--url https://api.nxos.io/v1/organizations/nxosnet \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"handle": "<string>",
"showOrganizationName": true
}
'import requests
url = "https://api.nxos.io/v1/organizations/nxosnet"
payload = {
"enabled": True,
"handle": "<string>",
"showOrganizationName": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, handle: '<string>', showOrganizationName: true})
};
fetch('https://api.nxos.io/v1/organizations/nxosnet', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nxos.io/v1/organizations/nxosnet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'handle' => '<string>',
'showOrganizationName' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nxos.io/v1/organizations/nxosnet"
payload := strings.NewReader("{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.nxos.io/v1/organizations/nxosnet")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations/nxosnet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"handle\": \"<string>\",\n \"showOrganizationName\": true\n}"
response = http.request(request)
puts response.read_body{
"object": "nxosnet_settings",
"enabled": true,
"handle": "acme",
"showOrganizationName": true
}{
"error": {
"code": "invalid_request",
"message": "The request body is malformed or missing required fields.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "missing_api_key",
"message": "No Authorization header provided.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "forbidden",
"message": "Your organization is not enabled for this action.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "quote_expired",
"message": "The quote has expired.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected server error occurred.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}