Create a Domain

Create a new file serving Domain under your account.

Please note: Offensive domain names will be replaced with ****

POST https://{region}.getafile.io/api/v1/teams/:team_id/domain

This endpoint allows you to create a new Domain.

Path Parameters

Name
Type
Description

team_id

number

ID of the team

Request Body

Name
Type
Description

domain*

string

The Domain you wish to use: eg test.getafile.online

name*

string

Reference name for the Domain

google_analytics_id_consent*

number

Specify if this is your own domain, or a subdomain of getafile.online 1 = Yes 0 = No

google_analytics_id

string

The google analytics ID tied to the domain (required if google_analytics_id_consent = 0)

google_analytics_id_secret

string

The google analytics secret tied to the domain (required if google_analytics_id_consent = 0)

domaincustom

array

An array of CustomDomain objects. See example request payload

{
    "name": "Testing",
    "domain": "testing.getafile.online",
    "google_analytics_id_consent": 0,
    "user_id": 1,
    "team_id": "8",
    "active": 1,
    "created_at": "2024-04-18T13:43:55.088+10:00",
    "updated_at": "2024-04-18T13:43:55.089+10:00",
    "id": 1,
    "domaincustom": [
        {
            "id": 1,
            "domain_id": 1,
            "custom_domain": "test.example.com",
            "resolved": 0,
            "setup": 0
        }
    ],
    "logo_uri": null,
    "favicon_uri": null
}

Example Request

Last updated

Was this helpful?