Create Service

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/service-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_name": "John Doe",
  "client_email": "[email protected]",
  "plan": "standard-vps",
  "vps_language": "english",
  "auto_approve": true,
  "trading_account_number": "ACC123456",
  "notes": "Create this service for the London desk."
}
'

import requests

url = "https://brokers.newyorkcityservers.com/api/v1/service-create"

payload = {
    "client_name": "John Doe",
    "client_email": "[email protected]",
    "plan": "standard-vps",
    "vps_language": "english",
    "auto_approve": True,
    "trading_account_number": "ACC123456",
    "notes": "Create this service for the London desk."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_name: 'John Doe',
    client_email: '[email protected]',
    plan: 'standard-vps',
    vps_language: 'english',
    auto_approve: true,
    trading_account_number: 'ACC123456',
    notes: 'Create this service for the London desk.'
  })
};

fetch('https://brokers.newyorkcityservers.com/api/v1/service-create', 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://brokers.newyorkcityservers.com/api/v1/service-create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_name' => 'John Doe',
    'client_email' => '[email protected]',
    'plan' => 'standard-vps',
    'vps_language' => 'english',
    'auto_approve' => true,
    'trading_account_number' => 'ACC123456',
    'notes' => 'Create this service for the London desk.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://brokers.newyorkcityservers.com/api/v1/service-create"

	payload := strings.NewReader("{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://brokers.newyorkcityservers.com/api/v1/service-create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/service-create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "service_number": 971100321,
    "request_id": "REQ-000321",
    "created_date": "2026-06-23T12:00:00.000Z"
  }
}

POST

service-create

Create Service

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/service-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_name": "John Doe",
  "client_email": "[email protected]",
  "plan": "standard-vps",
  "vps_language": "english",
  "auto_approve": true,
  "trading_account_number": "ACC123456",
  "notes": "Create this service for the London desk."
}
'

import requests

url = "https://brokers.newyorkcityservers.com/api/v1/service-create"

payload = {
    "client_name": "John Doe",
    "client_email": "[email protected]",
    "plan": "standard-vps",
    "vps_language": "english",
    "auto_approve": True,
    "trading_account_number": "ACC123456",
    "notes": "Create this service for the London desk."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_name: 'John Doe',
    client_email: '[email protected]',
    plan: 'standard-vps',
    vps_language: 'english',
    auto_approve: true,
    trading_account_number: 'ACC123456',
    notes: 'Create this service for the London desk.'
  })
};

fetch('https://brokers.newyorkcityservers.com/api/v1/service-create', 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://brokers.newyorkcityservers.com/api/v1/service-create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_name' => 'John Doe',
    'client_email' => '[email protected]',
    'plan' => 'standard-vps',
    'vps_language' => 'english',
    'auto_approve' => true,
    'trading_account_number' => 'ACC123456',
    'notes' => 'Create this service for the London desk.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://brokers.newyorkcityservers.com/api/v1/service-create"

	payload := strings.NewReader("{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://brokers.newyorkcityservers.com/api/v1/service-create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/service-create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_name\": \"John Doe\",\n  \"client_email\": \"[email protected]\",\n  \"plan\": \"standard-vps\",\n  \"vps_language\": \"english\",\n  \"auto_approve\": true,\n  \"trading_account_number\": \"ACC123456\",\n  \"notes\": \"Create this service for the London desk.\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "service_number": 971100321,
    "request_id": "REQ-000321",
    "created_date": "2026-06-23T12:00:00.000Z"
  }
}

Create a VPS service for a client. You can request automatic approval or submit the request for manual approval.

Behavior

When auto_approve is true, the API starts service provisioning immediately. When auto_approve is false, the API creates a pending service request and alerts your eligible staff members for review. Service provisioning happens only if the service request is approved manually.

Responses

A request can return HTTP 200 or HTTP 202.

Automatic Approval

When automatic approval succeeds, the endpoint returns HTTP 200.

Manual Approval

When auto_approve is false, the endpoint creates a pending service request and returns HTTP 202.

Processing And Review

The endpoint returns HTTP 202 when processing is still in progress or when a setup problem needs further review from NYCServers. In this situation the submission should be treated as submitted, and a re-try is not needed.

Errors

All error responses have success: false and an error object.

HTTP status	Error code	Cause
`400`	`invalid_request`	The body is not valid JSON, or a field has the wrong type.
`400`	`missing_parameter`	`client_name`, `client_email`, or `plan` is missing or empty.
`400`	`invalid_parameter`	The email, plan, or language is not valid.
`401`	`authentication_failed`	The Bearer token is missing, invalid, inactive, or expired.
`403`	`insufficient_permissions`	The request IP is not allowed, or the key does not have a required scope.
`429`	`rate_limit_exceeded`	The key has reached its rate limit. The `Retry-After` header gives the wait time in seconds.
`500`	`server_error`	The request, authentication, or provisioning workflow could not complete.

Authorizations

Authorization

string

header

required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Body

application/json

client_name

string

required

Minimum string length: 1

client_email

string<email>

required

plan

string

required

Plan slug or label, accepted case-insensitively. Valid slugs are basic-vps, standard-vps, professional-vps, and dedicated-server.

vps_language

string

default:english

Language value or configured display label accepted case-insensitively. Values are english, spanish, french, german, italian, portuguese, russian, chinese, arabic, malay, thai, vietnamese, hindi, urdu, bengali, turkish, polish, ukrainian, romanian, and dutch.

auto_approve

boolean

default:true

trading_account_number

string | null

notes

string | null

Response

Service created.

success

boolean

required

data

object

required

Show child attributes

message

string

pagination

object

Show child attributes

Last modified on August 2, 2026

Sandbox Mode

List Services

Getting Started

Services

Requests

Reports

Create Service

Behavior

Responses

Automatic Approval

Manual Approval

Processing And Review

Errors

Authorizations

Body

Response

​Behavior

​Responses

​Automatic Approval

​Manual Approval

​Processing And Review

​Errors

Authorizations

Body

Response

Behavior

Responses

Automatic Approval

Manual Approval

Processing And Review

Errors