SendCloud

# Tracking Domain

# Query (Batch Query)

URL

https://api2.sendcloud.net/api/trackDomain/list
1

HTTP Request Method

GET POST
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
name string no track name, multiple names are separated by semicolons
start int no amount, [0-100], defaults to 100
limit int no amount, [0-100], defaults to 100

Request Example

curl -d 'apiUser=***&apiKey=***&start=0&limit=100' https://api2.sendcloud.net/api/trackDomain/list
1

Returned value description

parameter description
id track ID
name track name
cname cname configuration, true: passed false: failed
gmtCreated time of track creation
gmtUpdated time of track modification
cname.domain track host records
cname.value record value to configure for track
https https configuration, true：configured false：not configured
certiValidityStart The start time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）
certiValidityEnd The end time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）

Returned Value Example

{
	 "info": {
    "dataList": [
  					{
                "id": 999225,
                "name": "track2.test.com",
                "cname": false,
                "gmtCreated": "2014-11-01 22:41:52",
                "gmtUpdated": "2015-09-25 10:56:06",
                "cname.domain": "test.com",
                "cname.value": "test.com",
                "https": false,
                "certiValidityStart": "",
                "certiValidityEnd": ""
            },
            {
                "id": 999224,
                "name": "track.test.com",
                 "cname": false,
                "gmtCreated": "2014-11-01 22:41:52",
                "gmtUpdated": "2015-09-25 10:56:06",
                "cname.domain": "test.com",
                "cname.value": "test.com",
                "https": false,
                "certiValidityStart": "",
                "certiValidityEnd": ""
            }
    ],
    "total": 2,
    "count": 2
  },
  "statusCode": 200,
  "message": "request was successful",
  "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# Add

URL

https://api2.sendcloud.net/api/trackDomain/add
1

HTTP Request Method

POST
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
name string yes track name, comply with the domain name specification, the length does not exceed 255 characters
certContent string no certificate content（PEM format）
certKey string no certificate private key（PEM format）

Tips：

  1. The tracking domain name cannot be the same as any sending domain name.
  2. CertContent and CertKey must both be empty or pass values simultaneously.
  3. A user may add a maximum of 5 domains for tracking. If you require more than five tracking domains, kindly reach out to our customer support team.

Request Example

curl -d 'apiUser=***&apiKey=**&name=test.com' https://api2.sendcloud.net/api/trackDomain/add
1

Returned value description

parameter description
id track ID
name track name
cname cname configuration, true: passed，false: failed
gmtCreated time of track creation
gmtUpdated time of track modification
cname.domain track host records
cname.value record value to configure for track
https https configuration, true：configured，false：not configured
certiValidityStart The start time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）
certiValidityEnd The end time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）

Returned Value Example

{ 
  "result": true,
  "statusCode": 200,
  "message": "request was successful",
  "info": {
      data: {
         "id": 999224,
         "name": "track.test.com", 
         "cname": false,
         "gmtCreated": "2014-11-01 22:41:52",
         "gmtUpdated": "2015-09-25 10:56:06",
         "cname.domain": "test.com",
         "cname.value": "test.com",
         "https": false,
          "certiValidityStart": "",
          "certiValidityEnd": ""
      }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Modify

URL

https://api2.sendcloud.net/api/trackDomain/update
1

HTTP Request Method

post
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
id Integer yes track id
name string no new track name
certContent string no certificate content（PEM format）
certKey string no certificate private key（PEM format）

Request Example

curl -d 'apiUser=***&apiKey=***&id=68554&name=test.com' https://api2.sendcloud.net/api/trackDomain/update
1

Returned value description

parameter description
id track ID
name track name
cname cname configuration, true: passed，false: failed
gmtCreated time of track creation
gmtUpdated time of track modification
cname.domain track host records
cname.value record value to configure for track
https https configuration, true：configured，false：not configured
certiValidityStart The start time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）
certiValidityEnd The end time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）

Returned Value Example

{
  "result": true,
  "statusCode": 200,
  "message": "request was successful",
  "info": {
      data: {
         "id": 999224,
         "name": "track.test.com", 
         "cname": false,
         "gmtCreated": "2014-11-01 22:41:52",
         "gmtUpdated": "2015-09-25 10:56:06",
         "cname.domain": "test.com",
         "cname.value": "test.com",
         "https": false,
          "certiValidityStart": "",
          "certiValidityEnd": ""
      }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Verify

URL

https://api2.sendcloud.net/api/trackDomain/checkConfig
1

HTTP Request Method

GET POST
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
id string no track id, multiple ids are separated by semicolons
name string no track name, multiple names are separated by semicolons

Tips：

  1. Calling this interface will update the status of cname.
  2. Both id and name cannot be blank simultaneously.

Request Example

curl -d 'apiUser=***&apiKey=***&id=68554' https://api2.sendcloud.net/api/trackDomain/checkConfig
1

Returned value description

parameter description
id track ID
name track name
cname cname configuration, true: passed，false: failed
gmtCreated time of track creation
gmtUpdated time of track modification
cname.domain track host records
cname.value record value to configure for track
https https configuration, true：configured，false：not configured
certiValidityStart The start time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）
certiValidityEnd The end time of the SSL certificate validity period（ yyyy-MM-dd HH:mm:ss）

Returned Value Example

{ 
	 "info": {
    "dataList": [
  					{
                "id": 999225,
                "name": "track2.test.com",
                "cname": false,
                "gmtCreated": "2014-11-01 22:41:52",
                "gmtUpdated": "2015-09-25 10:56:06",
                "cname.domain": "test.com",
                "cname.value": "test.com",
                "https": false,
                "certiValidityStart": "",
          			"certiValidityEnd": ""
            },
            {
                "id": 999224,
                "name": "track.test.com",  
                "cname": false,
                "gmtCreated": "2014-11-01 22:41:52",
                "gmtUpdated": "2015-09-25 10:56:06",
                "cname.domain": "test.com",
                "cname.value": "test.com",
                "https": false,
                "certiValidityStart": "",
          			"certiValidityEnd": ""
            }
    ],
    "count": 2
  },
  "statusCode": 200,
  "message": "request was successful",
  "result": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# Delete

URL

https://api2.sendcloud.net/api/trackDomain/delete
1

Parameter Description

post get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
id int yes track ID

Request Example

curl -d 'apiUser=***&apiKey=***&id=68554' https://api2.sendcloud.net/api/trackDomain/delete
1

Returned value description

parameter description
count count of deleted track domain

Returned Value Example

{
  "statusCode": 200,
  "info": {
    "count": 1
  },
  "message": "request was successful",
  "result": true
}
1
2
3
4
5
6
7
8
Last Updated: 2025/03/25 10:38:59

User Information

Query (Batch Query)
Add
Modify
Verify
Delete