Create Service
Create a VPS service or submit a service request for approval.
Choose a plan
Use List Plans to obtain your active broker catalog, then pass the planslug, id, or display name in plan. Catalog validation also applies to Sandbox creation.
Behavior
Whenauto_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 HTTP200 or HTTP 202.
Automatic approval
When automatic approval succeeds, the endpoint returns HTTP200.
Manual approval
Whenauto_approve is false, the endpoint creates a pending service request and returns HTTP 202.
Processing and review
The endpoint returns HTTP202 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.
Use a unique X-Idempotency-Key for each intended creation and reuse it for retries with the same input. Without the header, repeated calls can create separate requests. Read Errors and Retries before retrying a timeout or error.
Endpoint errors
For authentication, permissions, rate limits, and safe retries, see Errors and Retries.Authorizations
Send the API key in the Authorization bearer header. Production keys begin with sk_live_.
Headers
Unique key for one intended operation. Reuse with unchanged input for retries. Supported by service creation, plan changes, cancellation, and request approval (not denial). Creation replays by key without checking changed input; action payload conflicts can return 409. See /api/errors-and-retries for endpoint-specific behavior.
Body
1Active broker catalog plan id, slug, or display name. Slugs and display names are matched case-insensitively. Use GET /v1/plans for available choices. Catalog validation also applies in Sandbox Mode.
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.

