Create a domain

Create a domain

POST 
undefined/functions/v1/domains

Create a domain

Request

Header Parameters

X-Organization-Id string

The ID of the organization (this parameter is not required when using API key authorization)

application/json

Bodyrequired

domainstring
The domain name
Default value: string

Responses

200

Success

application/json

Schema

Schema

successboolean
Default value: true
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 200
statusTextstring
Default value: Success
messagestring
Default value: domain created
localizationstring
Default value: someone-method:success
data object
idstring
Default value: string
organizationIdstring
Default value: string
domainstring
Default value: string
ipstring
Default value: string
createdAtdate-time
updatedAtdate-time

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Success",
  "message": "domain created",
  "localization": "someone-method:success",
  "data": {
    "id": "string",
    "organizationId": "string",
    "domain": "string",
    "ip": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}

400

Bad Request

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 400
statusTextstring
Default value: Bad Request
messagestring
Default value: Message Error
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 400,
  "statusText": "Bad Request",
  "message": "Message Error",
  "localization": "someone-method:error"
}

401

Unauthorized

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 401
statusTextstring
Default value: Unauthorized
messagestring
Default value: Message Unauthorized
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 401,
  "statusText": "Unauthorized",
  "message": "Message Unauthorized",
  "localization": "someone-method:error"
}

403

Forbidden

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 403
statusTextstring
Default value: Forbidden
messagestring
Default value: Message Forbidden
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 403,
  "statusText": "Forbidden",
  "message": "Message Forbidden",
  "localization": "someone-method:error"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "undefined/functions/v1/domains");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var content = new StringContent("{\n  \"domain\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

undefined/functions/v1

Auth

apiKeyAuth

Parameters

X-Organization-Id — header

Body required

{
  "domain": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!