NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

Addon management

APIs for managing Addon

Get addons list.


Requires authentication Addons that available to the user with a current subscription.

Return list of addons

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/addons" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/addons");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": [
        {
            "id": 1,
            "name": "Add 10 clients",
            "price": 20,
            "billing_cycle": "month",
            "mount_points": 0,
            "clients": 10,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 3,
            "name": "Add 10 mount points",
            "price": 20,
            "billing_cycle": "month",
            "mount_points": 10,
            "clients": 0,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 5,
            "name": "Add 50 clients",
            "price": 100,
            "billing_cycle": "month",
            "mount_points": 0,
            "clients": 50,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 7,
            "name": "Add 50 mount points",
            "price": 100,
            "billing_cycle": "month",
            "mount_points": 50,
            "clients": 0,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 9,
            "name": "Add 100 clients",
            "price": 200,
            "billing_cycle": "month",
            "mount_points": 0,
            "clients": 100,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 11,
            "name": "Add 100 mount points",
            "price": 200,
            "billing_cycle": "month",
            "mount_points": 100,
            "clients": 0,
            "created_at": null,
            "updated_at": null
        }
    ]
}

HTTP Request

GET api/v2/addons

Buy Addon


Requires authentication Return an addon item.

Example request:

curl -X POST "https://api.youcors.com/api/v2/addons" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"addon_id":"qui"}'
const url = new URL("https://api.youcors.com/api/v2/addons");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "addon_id": "qui"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "addon_id": 11,
        "user_id": 821,
        "subscription_id": 79,
        "updated_at": "2019-10-16 14:02:16",
        "created_at": "2019-10-16 14:02:16",
        "id": 1
    }
}

HTTP Request

POST api/v2/addons

Body Parameters

Parameter Type Status Description
addon_id string required Addon id.

Caster management

APIs for managing casters

Get caster key


Requires authentication Return list of casters

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/casters/1/key" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/casters/1/key");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": "caster key"
}

HTTP Request

GET api/v2/casters/{id}/key

Get caster list


Requires authentication Return list of casters

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/casters" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/casters");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": [
        {
            "id": 2,
            "user_id": 14,
            "name": "YC Amsterdam",
            "url": "am.youcors.com",
            "ip": "95.85.53.176",
            "port": 2101,
            "location": "Amsterdam, Netherlands",
            "version": "1.0",
            "type": 0,
            "created_at": "2017-02-10 07:30:06",
            "updated_at": "2017-02-10 07:30:06"
        }
    ]
}

HTTP Request

GET api/v2/casters

Create caster


Requires authentication Return caster. The endpoint is available only to Enterprise plan users or admins.

Example request:

curl -X POST "https://api.youcors.com/api/v2/casters" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"name":"qui","url":"accusantium","ip":"sed","port":6,"location":"explicabo","type":14}'
const url = new URL("https://api.youcors.com/api/v2/casters");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "name": "qui",
    "url": "accusantium",
    "ip": "sed",
    "port": 6,
    "location": "explicabo",
    "type": 14
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "user_id": 123,
        "name": "My caster",
        "url": "my.caster.com",
        "ip": "123.123.123.123",
        "port": 2101,
        "location": "Pacific ocean",
        "version": "1.0",
        "key": "84d5de7a2fe378b5025750d15e49a6f3",
        "type": 1,
        "updated_at": "2019-10-05 09:47:25",
        "created_at": "2019-10-05 09:47:25",
        "id": 16
    }
}

HTTP Request

POST api/v2/casters

Body Parameters

Parameter Type Status Description
name string required Mount point name.
url string optional Caster URL. Max: 255.
ip string required IPV4 caster address.
port integer required Port number. Between:0,65535.
location string required Caster lacation. Max: 255.
type integer required Caster type. 0 - Public, 1 - Private.

api/v2/casters/{id}

Example request:

curl -X PUT "https://api.youcors.com/api/v2/casters/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/casters/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/v2/casters/{id}

api/v2/casters/{id}

Example request:

curl -X DELETE "https://api.youcors.com/api/v2/casters/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/casters/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/v2/casters/{id}

Mount point management

APIs for managing mount points

Validate a mount point name


Requires authentication Mount point names must be unique

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/validatename?name=repellat&id=cumque" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/validatename");

    let params = {
            "name": "repellat",
            "id": "cumque",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": true
}

HTTP Request

GET api/v2/mountpoints/validatename

Query Parameters

Parameter Status Description
name required Mount point name
id optional Mount point id if it exist

Get mount point list


Requires authentication Return list of mount points

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "mountpoints": [
            {
                "id": 1,
                "user_id": 1,
                "caster_id": 1,
                "name": "SUR40",
                "type": 1,
                "data_source": 0,
                "created_at": "2019-03-07 08:27:30",
                "updated_at": "2019-03-14 08:04:37",
                "uptime": 0,
                "description": {
                    "id": 2,
                    "mountpoint_id": 1,
                    "identifier": null,
                    "format": null,
                    "format_details": null,
                    "carrier": null,
                    "nav_system": [
                        "GPS",
                        "BDS"
                    ],
                    "network": null,
                    "country": null,
                    "latitude": null,
                    "longitude": null,
                    "nmea": 0,
                    "solution": null,
                    "generator": null,
                    "compr_encryp": "none",
                    "authentication": "B",
                    "fee": "N",
                    "bitrate": null,
                    "misc": null,
                    "created_at": "2019-03-13 10:16:33",
                    "updated_at": "2019-03-13 10:16:33"
                },
                "relay": {
                    "id": 2,
                    "user_id": 1,
                    "mountpoint_id": 1,
                    "ntrip_version_id": 2,
                    "source_mountpoint": "BCLN00ESP0",
                    "host": "www.euref-ip.net",
                    "port": 2101,
                    "username": "ivial98",
                    "restart": 0,
                    "created_at": "2019-03-13 10:14:01",
                    "updated_at": "2019-03-13 10:14:01"
                },
                "directip": null,
                "ntrip": {
                    "id": 2,
                    "mountpoint_id": 1,
                    "user_id": 1,
                    "ntrip_version": 1,
                    "username": null,
                    "created_at": "2019-03-14 08:04:49",
                    "updated_at": "2019-03-14 08:04:49"
                }
            },
            {
                "id": 4,
                "user_id": 1,
                "caster_id": 2,
                "name": "test2",
                "type": 0,
                "data_source": 0,
                "created_at": "2019-03-15 06:39:07",
                "updated_at": "2019-03-15 06:39:07",
                "uptime": 0,
                "description": null,
                "relay": null,
                "directip": null,
                "ntrip": {
                    "id": 4,
                    "mountpoint_id": 4,
                    "user_id": 1,
                    "ntrip_version": 1,
                    "username": null,
                    "created_at": "2019-03-15 06:39:26",
                    "updated_at": "2019-03-15 06:39:26"
                }
            }
        ]
    }
}

HTTP Request

GET api/v2/mountpoints

Create mount point


Requires authentication Return mount point

Example request:

curl -X POST "https://api.youcors.com/api/v2/mountpoints" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"name":"blanditiis","casterId":2}'
const url = new URL("https://api.youcors.com/api/v2/mountpoints");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "name": "blanditiis",
    "casterId": 2
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "user_id": 1,
        "caster_id": 1,
        "name": "regr",
        "updated_at": "2019-03-18 15:25:16",
        "created_at": "2019-03-18 15:25:16",
        "id": 5,
        "description": null,
        "relay": null,
        "directip": null,
        "ntrip": null
    }
}

HTTP Request

POST api/v2/mountpoints

Body Parameters

Parameter Type Status Description
name string required Mount point name.
casterId integer required Caster id.

Get mount point


Requires authentication Return mount point

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "id": 1,
        "user_id": 1,
        "caster_id": 1,
        "name": "SUR40",
        "type": 1,
        "data_source": 0,
        "created_at": "2019-03-07 08:27:30",
        "updated_at": "2019-03-14 08:04:37",
        "uptime": 0,
        "description": {
            "id": 2,
            "mountpoint_id": 1,
            "identifier": null,
            "format": null,
            "format_details": null,
            "carrier": null,
            "nav_system": [
                "GPS",
                "BDS"
            ],
            "network": null,
            "country": null,
            "latitude": null,
            "longitude": null,
            "nmea": 0,
            "solution": null,
            "generator": null,
            "compr_encryp": "none",
            "authentication": "B",
            "fee": "N",
            "bitrate": null,
            "misc": null,
            "created_at": "2019-03-13 10:16:33",
            "updated_at": "2019-03-13 10:16:33"
        },
        "relay": {
            "id": 2,
            "user_id": 1,
            "mountpoint_id": 1,
            "ntrip_version_id": 2,
            "source_mountpoint": "BCLN00ESP0",
            "host": "www.euref-ip.net",
            "port": 2101,
            "username": "ivial98",
            "restart": 0,
            "created_at": "2019-03-13 10:14:01",
            "updated_at": "2019-03-13 10:14:01"
        },
        "directip": null,
        "ntrip": {
            "id": 2,
            "mountpoint_id": 1,
            "user_id": 1,
            "ntrip_version": 1,
            "username": null,
            "created_at": "2019-03-14 08:04:49",
            "updated_at": "2019-03-14 08:04:49"
        }
    }
}

HTTP Request

GET api/v2/mountpoints/{id}

Delete mount point


Requires authentication

Example request:

curl -X DELETE "https://api.youcors.com/api/v2/mountpoints/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": true
}

HTTP Request

DELETE api/v2/mountpoints/{id}

Update mount point


Requires authentication Return mount point

Example request:

curl -X PUT "https://api.youcors.com/api/v2/mountpoints/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"name":"velit","casterId":11}'
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "name": "velit",
    "casterId": 11
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "user_id": 1,
        "caster_id": 1,
        "name": "regr",
        "updated_at": "2019-03-18 15:25:16",
        "created_at": "2019-03-18 15:25:16",
        "id": 5,
        "description": null,
        "relay": null,
        "directip": null,
        "ntrip": null
    }
}

HTTP Request

PUT api/v2/mountpoints/{id}

Body Parameters

Parameter Type Status Description
name string required Mount point name.
casterId integer required Caster id.

Switch mount point input source


Requires authentication

Example request:

curl -X POST "https://api.youcors.com/api/v2/mountpoints/1/switchsource" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"data_source":2}'
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/switchsource");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "data_source": 2
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": true
}

HTTP Request

POST api/v2/mountpoints/{id}/switchsource

Body Parameters

Parameter Type Status Description
data_source integer required 0 - NTRIP, 1 - Relay, 2 - DirectIP.

Get relay


Requires authentication Return relay

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1/relay?id=architecto" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/relay");

    let params = {
            "id": "architecto",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "id": 2,
        "user_id": 2,
        "mountpoint_id": 2,
        "ntrip_version_id": 1,
        "source_mountpoint": "ACOR00ESP0",
        "host": "www.euref-ip.net",
        "port": 2101,
        "username": "ivial982",
        "restart": 0,
        "created_at": "2019-03-23 06:55:13",
        "updated_at": "2019-03-30 06:33:02"
    }
}

HTTP Request

GET api/v2/mountpoints/{id}/relay

Query Parameters

Parameter Status Description
id required Mount point id

Create or update relay


Requires authentication Return relay

Example request:

curl -X PUT "https://api.youcors.com/api/v2/mountpoints/1/relay?id=officiis" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"host":"dolores","port":15,"source_mountpoint":"ea","username":"aut","password":"dicta","ntrip_version_id":8}'
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/relay");

    let params = {
            "id": "officiis",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "host": "dolores",
    "port": 15,
    "source_mountpoint": "ea",
    "username": "aut",
    "password": "dicta",
    "ntrip_version_id": 8
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "id": 2,
        "user_id": 2,
        "mountpoint_id": 2,
        "ntrip_version_id": 1,
        "source_mountpoint": "ACOR00ESP0",
        "host": "www.euref-ip.net",
        "port": 2101,
        "username": "ivial982",
        "restart": 0,
        "created_at": "2019-03-23 06:55:13",
        "updated_at": "2019-03-30 06:33:02"
    }
}

HTTP Request

PUT api/v2/mountpoints/{id}/relay

Body Parameters

Parameter Type Status Description
host string required Remote caster domain name or IPV4
port integer required Remote caster port number between 0,65535
source_mountpoint string required Mount point name on remote caster alpha_num max:255
username string required Username on remote caster alpha_num max:255
password string required Password on remote caster max:255
ntrip_version_id integer required NTRIP version 1 - NTRIP protocol v1, 2 - NTRIP protocol v2

Query Parameters

Parameter Status Description
id required Mount point id

NTRIP input management

APIs for managing NTRIP input

Get NTRIP


Requires authentication Return NTRIP input credentials

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1/ntrip?id=mollitia" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/ntrip");

    let params = {
            "id": "mollitia",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "id": 2,
        "mountpoint_id": 2,
        "user_id": 1,
        "ntrip_version": 2,
        "username": "ivial981",
        "created_at": "2019-03-01 11:31:48",
        "updated_at": "2019-03-30 07:34:28"
    }
}

HTTP Request

GET api/v2/mountpoints/{id}/ntrip

Query Parameters

Parameter Status Description
id required Mount point id

Create or update mount point NTRIP input source


Requires authentication Return ntrip

Example request:

curl -X PUT "https://api.youcors.com/api/v2/mountpoints/1/ntrip?id=quam" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"username":"dignissimos","password":"eveniet","ntrip_version_id":11}'
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/ntrip");

    let params = {
            "id": "quam",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "username": "dignissimos",
    "password": "eveniet",
    "ntrip_version_id": 11
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "id": 2,
        "mountpoint_id": 2,
        "user_id": 1,
        "ntrip_version": 2,
        "username": "ivial98",
        "created_at": "2019-03-01 11:31:48",
        "updated_at": "2019-03-30 07:50:05"
    }
}

HTTP Request

PUT api/v2/mountpoints/{id}/ntrip

Body Parameters

Parameter Type Status Description
username string optional Username required if ntrip_version_id qual 2 alpha_num max:255
password string optional Password required to create new NTRIP credential max:255
ntrip_version_id integer required NTRIP version 1 - NTRIP protocol v1, 2 - NTRIP protocol v2

Query Parameters

Parameter Status Description
id required Mount point id

Notifications management

APIs for managing notifications

Get notifications list


Requires authentication Return list of notifications

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/notifications" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/notifications");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": [
        {
            "id": 7,
            "user_id": 1,
            "caster_id": 7,
            "server_id": 708,
            "client_id": null,
            "code": "hrDb",
            "level": "warning",
            "message": "Base station connection declined. Invalid NTRIP password.",
            "data": "{\"uri\": \"TestServer\", \"type\": \"Server\", \"method\": \"SOURCE\", \"chunked\": false, \"headers\": [], \"http_version\": \"HTTP\/1.0\", \"ntrip_version\": 1}",
            "created_at": "2019-07-28 08:52:45",
            "updated_at": "2019-07-28 08:52:45"
        }
    ]
}

HTTP Request

GET api/v2/notifications

User Authentication

Auth

Use this endpoint to get user authentication token

Example request:

curl -X POST "https://api.youcors.com/api/v2/auth" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"email":"aut","password":"nulla"}'
const url = new URL("https://api.youcors.com/api/v2/auth");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "email": "aut",
    "password": "nulla"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "token": "token"
}

Example response (401):

{
    "error": "invalid_credentials"
}

HTTP Request

POST api/v2/auth

Body Parameters

Parameter Type Status Description
email string required user email
password string required user password

Register

Use this endpoint to create new user

Example request:

curl -X POST "https://api.youcors.com/api/v2/register" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"name":"quibusdam","email":"esse","password":"quae"}'
const url = new URL("https://api.youcors.com/api/v2/register");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "name": "quibusdam",
    "email": "esse",
    "password": "quae"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "token": "token"
}

Example response (401):

{
    "error": "invalid_credentials"
}

HTTP Request

POST api/v2/register

Body Parameters

Parameter Type Status Description
name string required user name alphabetic characters and spaces only max:20
email string required user email
password string required user password

Resend

Use this endpoint to resend email confirmation

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/resend" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/resend");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": true
}

HTTP Request

GET api/v2/resend

api/v2/verify

Example request:

curl -X POST "https://api.youcors.com/api/v2/verify" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/verify");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/v2/verify

api/v2/reset

Example request:

curl -X POST "https://api.youcors.com/api/v2/reset" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/reset");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/v2/reset

api/v2/passwordupdate

Example request:

curl -X POST "https://api.youcors.com/api/v2/passwordupdate" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/passwordupdate");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/v2/passwordupdate

general

api/v2/user

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/user" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/user");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/user

api/v2/mountpoints/{id}/description

Example request:

curl -X PUT "https://api.youcors.com/api/v2/mountpoints/1/description" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/description");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/v2/mountpoints/{id}/description

api/v2/mountpoints/{id}/sessions

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1/sessions" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/sessions");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/mountpoints/{id}/sessions

api/v2/mountpoints/{id}/directip

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1/directip" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/directip");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/mountpoints/{id}/directip

api/v2/mountpoints/{id}/directip/generate

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/mountpoints/1/directip/generate" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/mountpoints/1/directip/generate");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/mountpoints/{id}/directip/generate

validatename

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/clients/validatename" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients/validatename");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/clients/validatename

api/v2/clients

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/clients" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/clients

api/v2/clients

Example request:

curl -X POST "https://api.youcors.com/api/v2/clients" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/v2/clients

api/v2/clients/{id}

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/clients/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/clients/{id}

api/v2/clients/{id}

Example request:

curl -X DELETE "https://api.youcors.com/api/v2/clients/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/v2/clients/{id}

api/v2/clients/{id}

Example request:

curl -X PUT "https://api.youcors.com/api/v2/clients/1" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/clients/1");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/v2/clients/{id}

api/v2/subscriptions/plans

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/subscriptions/plans" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/subscriptions/plans");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/subscriptions/plans

api/v2/subscriptions/current

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/subscriptions/current" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/subscriptions/current");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/subscriptions/current

api/v2/subscriptions

Example request:

curl -X GET -G "https://api.youcors.com/api/v2/subscriptions" \
    -H "Authorization: Bearer {token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL("https://api.youcors.com/api/v2/subscriptions");

let headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Token not provided"
}

HTTP Request

GET api/v2/subscriptions