openapi: 3.0.3
info:
description: API Documentation
version: 2.0.0
title: DomainManager API
contact:
email: domain_api_support@cscglobal.com
servers:
- url: 'https://apis.cscglobal.com/dbs/api/v2'
description: Production
- url: 'https://apis-ote.cscglobal.com/dbs/api/v2'
description: Demo
security:
- ApiKey: []
BearerToken: []
tags:
- name: domains
description: View domain data and place domain orders
- name: zones
description: View zone data and submit zone changes
- name: events
description: View security events
- name: orders
description: View order data
- name: tls
description: View certificate data and place tls orders
- name: admin
description: View admin data
- name: dsrecords
description: 'View, add, and remove Delegation Signer records'
- name: token
description: View token actions
- name: urlf
description: View URL forwarding data and add or remove nodes
paths:
'/domains/{qualifiedDomainName}':
get:
tags:
- domains
summary: Get domain data by qualified domain name
description: |
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/domains/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class DomainsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/domains?filter=qualifiedDomainName=="example.com" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class DomainsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains?filter=qualifiedDomainName==example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains?filter=qualifiedDomainName==\"example.com\""
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all domains with a qualifiedDomainName of example.com
```
qualifiedDomainName=="example.com"
```
Find all domains with a qualifiedDomainName like example
```
qualifiedDomainName=like="example\*"
```
Find all domains with a registrationDate greater than Jan 05 2010
```
registrationDate=gt="05-JAN-2010"
```
Find all domains with a nameserver of dns1.mydns.com and an extension of 'com'
```
nameservers=="dns1.mydns.com";extension=="com"
```
Find all domains with a nameserver of dns1.mydns.com or dns2.mydns.com
```
nameservers=in=("dns1.mydns.com","dns2.mydns.com")
```
Find all domains with a WHOIS contact first name of Tom OR a last name of Smith
```
firstName=="Tom",lastName=="Smith"&sort=qualifiedDomainName,asc
```
Find all domains by business unit name Foo & Bar (encoded)
```
businessUnit=="Foo%20%26%20Bar"
```
---
required: false
schema:
type: string
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PagedDomainResponse'
/domains/availability:
get:
tags:
- domains
summary: Check registration availability for one or more domain names
description: |
Code examples
CURL
```bash
curl -X GET "https://apis.cscglobal.com/dbs/api/v2/domains/availability?qualifiedDomainNames=example.com,test.com" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class DomainsAvailability {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/availability?qualifiedDomainNames=example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/availability?qualifiedDomainNames=example.com,test.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/domains/configuration?size=1&page=1 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class DomainsConfiguration {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/configuration?size=1&page=1");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/configuration?size=1&page=1"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find configuration for the domain example.com
```
domain=="example.com"
```
Find all domains with a domainLabel like example
```
domainLabel=like="example*"
```
Find all domains with a registryExpiryDate greater than Jan 05 2020
```
registryExpiryDate=gt="2020-01-05"
```
Find all domains with an accountNumber of 1234567 or 0987654
```
accountNumber=in=(1234567, 0987654)
```
Find all domains with a valueRootA of 165.160.13.20 or 165.160.15.25 and an extension of 'com'
```
valueRootA=in=("165.160.13.20", "165.160.15.25");extension=="com"
```
Find all domains where isVital is true and either multiLocked is false or isMultilockEligible is false
```
isVital==true;multiLocked==false,isMultilockEligible==false
```
---
required: false
schema:
type: string
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
responses:
'200':
description: Domain Configuration Call Successful
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ConfigurationCallSuccess'
application/xml:
schema:
$ref: '#/components/schemas/ConfigurationCallSuccess'
/domains/registration:
post:
tags:
- domains
summary: Place a domain registration order
description: |
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/domains/registration -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DomainsReg {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/registration");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/registration"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/domains/nsmodification -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DomainsNSMod {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/nsmodification");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/nsmodification"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.put(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/domains/whoiscontactmodification -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.domains;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DomainsWhoisMod {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/domains/whoiscontactmodification");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/domains/whoiscontactmodification"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.put(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/zones/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all resource records with a recordType of A
```
recordType=="A"
```
Find all resource records with a key of "@" and a value like "165.160.*"
```
key="@";value=like="165.160.*"
```
Find all resource records with an 'A' record with a value of 1.2.3.4
```
(recordType=="a";value=="1.2.3.4")
```
Find all resource records that have a '10' or '20' priority
```
priority=in=("10","20")
```
Find all resource records with an 'A' record with a key of 'www' OR a 'CNAME' record with a value of 'www'
```
(recordType=="a";key=="www"),(recordType=="cname";value=="www")
```
---
responses:
'200':
description: zone found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/Zone'
application/xml:
schema:
$ref: '#/components/schemas/Zone'
'400':
description: malformed request
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
'404':
description: Domain not found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: DOMAIN_NOT_FOUND
description: Domain not found
value: example.com
/zones:
get:
tags:
- zones
summary: Get zone portfolio data
description: |
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/zones?filter=fullDomainName=="example.com" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones?filter=fullDomainName==\"example.com\"");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones?filter=fullDomainName==\"example.com\""
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all zones with a zoneName of example.com
```
zoneName=="example.com"
```
Find all zones with a zoneName like example
```
zoneName=like="\*example\*"
```
Find all zones with a ttlNeg less than 15000
```
ttlNeg=lt="15000"
```
Find all zones with an 'A' record with a value of 1.2.3.4
```
(recordType=="a";value=="1.2.3.4")
```
Find all zones that have a resource record with a '10' or '20' priority
```
priority=in=("10","20")
```
Find all zones with an 'A' record with a key of 'www' OR a 'CNAME' record with a value of 'www'
```
(recordType=="a";key=="www"),(recordType=="cname";value=="www")
```
---
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PagedZoneResponse'
/zones/edits:
get:
tags:
- zones
summary: Get one or more zone edits
description: |
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/zones/edits?filter=zoneName=="example.com" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesEditsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/edits?filter=zoneName==\"example.com\"");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/edits?filter=zoneName==\"example.com\""
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all zone edits for the zone of example.com
```
zoneName=="example.com"
```
Find all zone edits for a zone with a name like example
```
zoneName=like="\*example\*"
```
Find all zone edits with a modified date of March 31st, 2020
```
modifiedDate==31-Mar-2020
```
Find all zone edits with a modified date before March 31st, 2020 and with a status of 'CANCELED'
```
modifiedDate=lt=31-Mar-2020;status==canceled
```
---
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/ZoneEditSize'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PagedZoneEditResponse'
post:
tags:
- zones
summary: Submit and publish one or more zone edits
description: |
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/zones/edits -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class ZonesEditsPublish {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/edits");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/edits"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/zones/edits/status/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesEditStatusGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/edits/status/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/edits/status/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesEditsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X DELETE https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.zones;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class ZonesEditsDelete {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("DELETE");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/zones/edits/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.delete(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/events/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.events;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class EventsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/events/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/events/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/events?filter=eventType==DNS_CHANGE_REQUESTED -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.events;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class EventsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/events?filter=eventType==DNS_CHANGE_REQUESTED");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/events?filter=eventType==DNS_CHANGE_REQUESTED"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all events of type DNS_CHANGE_REQUESTED
```
eventType==DNS_CHANGE_REQUESTED
```
Find all events between two timestamps
```
eventdate=le=2019-09-25T00:00:00;eventDate=ge=2019-07-04T00:00:00
```
Find all LOGIN events that occurred after August 25, 2019
```
eventdate=gt=2019-08-25T00:00:00;eventType==LOGIN
```
---
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PagedEventResponse'
'/orderstatus/{orderUUID}':
get:
tags:
- orders
summary: Get orders by their UUID
description: |
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/orderstatus/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.orders;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class OrderStatusGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/orderstatus/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/orderstatus/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/orderstatus?filter=orderType==MULTILOCK -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.orders;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class OrderStatusGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/orderstatus?filter=orderType==MULTILOCK");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/orderstatus?filter=orderType==MULTILOCK"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all orders of type MULTILOCK
```
orderType==MULTILOCK
```
Find all orders between two dates
```
raisedDate=le=2019/09/25;raisedDate=ge=2019/07/04
```
Find all REGISTRATION orders that were raised after August 25, 2019
```
raisedDate=gt=2019/08/25;orderType==REGISTRATION
```
---
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/MultiOrderResponse'
'400':
description: Malformed request. The error code will give more details.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: SEARCH_MAX_LIMIT_REACHED
description: Order search is limited to 500 domains per search
value: orderType==REG;raisedDate=le=2019/12/10;raisedDate=ge=2019/12/06
'401':
description: No API token
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: NO_TOKEN
description: API bearer token invalid
value: 1234-fkef-21312-d32d
'403':
description: Not authorized
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: NO_PERMISSION
description: No permission for requested action
value: ''
'500':
description: Internal Server Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: ERROR
description: An unexpected error occurred...
value: ''
/tls/registration:
post:
tags:
- tls
summary: Place a TLS registration order
description: |
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/tls/registration -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class TLSRegistration {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/registration");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/registration"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/tls/renewal -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class TLSRenewalOrder {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/renewal");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/renewal"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/tls/reissue -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class TLSReissueOrder {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/reissue");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/reissue"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/tls/certificate/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class TLSCertificateGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/certificate/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/certificate/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/tls/certificate?filter=status==ACTIVE -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class TLSCertificateGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/certificate?filter=status==ACTIVE");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/certificate?filter=status==ACTIVE"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all certificates with status ACTIVE
```
status==ACTIVE
```
Find all certificates between two dates
```
expirationDate=le=2019/09/25;expirationDate=ge=2019/07/04
```
Find all certificate orders that have expiry date after August 25, 2019
```
expirationDate=gt=2019/08/25;status==ACTIVE
```
---
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/MultiTlsRetrieveResponse'
'401':
description: No API token
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: NO_TOKEN
description: API bearer token invalid
value: 1234-fkef-21312-d32d
'403':
description: Not authorized
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: NO_PERMISSION
description: No permission for requested action
value: ''
'500':
description: Internal Server Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
code: ERROR
description: An unexpected error occurred...
value: ''
'/tls/revoke/{uuid}':
put:
tags:
- tls
summary: Revoke certificate by UUID
description: |
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/tls/revoke/1234 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class TLSRevokeCertificate {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/revoke/1234");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/revoke/1234"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.put(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/tls/cname -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class TLSGenerateCname {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/cname");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/cname"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code Examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/tls/orgcontacts?filter=firstName==pat -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.tls;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class TLSContactsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/tls/orgcontacts?filter=lastName==smith");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/tls/orgcontacts"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/admin/businessunits/TEST%20BU -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.admin;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class BusinessUnitsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/businessunits/TEST%20BU");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/businessunits/TEST BU"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET "https://apis.cscglobal.com/dbs/api/v2/admin/businessunits?filter=businessUnitName==%22TEST%20BU%22" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.admin;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class BusinessUnitsGet {
public static void main(String[] args) throws IOException {
# search for business unit named "TEST BU" using URL encoding.
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/businessunits?filter=businessUnitName==%22TEST%20BU%22");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/businessunits?filter=businessUnitName==\"TEST BU\""
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all business units with a businessUnitName of TEST BU
```
businessUnitName=="TEST BU"
```
Find all business units with a businessUnitName like TEST
```
businessUnitName=like="TEST*"
```
Find all business units with a usage of DOMAIN and an accountNumber of 123456
```
usage=="DOMAIN";accountNumber=="123456"
```
Find all business units with a usage of DOMAIN or RELATED_SERVICES
```
usage=in=("DOMAIN","RELATED_SERVICES")
```
---
required: false
schema:
type: string
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/Size'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PagedBusinessUnitResponse'
'/admin/businessunit/{businessUnitName}/domain/{qualifiedDomainName}':
put:
tags:
- admin
summary: Modify the business unit associated with a domain
description: |
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/admin/businessunit/TEST%20BU/domain/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.admin;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class AdminModBusinessUnit {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/businessunit/TEST%20BU/domain/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/businessunit/TEST BU/domain/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.put(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/admin/customfields -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.admin;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class CustomFieldsGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/customfields");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/customfields"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/admin/customfields -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Content-Type: application/json" -d @myRequest.txt"
```
Java
```java
package com.cscglobal.admin;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class CustomFieldsMod {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/customfields");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/customfields"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.put(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET "https://apis.cscglobal.com/dbs/api/v2/admin/whoiscontactprofiles?filter=profileName==%22Example%20Name%22" -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.admin;
import java.io.IOException;
import java.net.URL;
import java.net.HttpURLConnection;
public class WhoisContactProfilesGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/admin/whoiscontactprofiles?filter=profileName==%22Example%20Name%22");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/admin/whoiscontactprofiles?filter=profileName==%22Example%20Name%22"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all profiles with a last name of Jones
``` lastName=="Jones" ```
Find all profiles with a last name like Jo
``` lastName=like="Jo*" ```
Find all profiles with a last name of Jones and a contact type of REGISTRANT
``` lastName=="Jones";contactTypes=="REGISTRANT" ```
Find all profiles with a contact type of TECHNICAL or ADMINISTRATIVE
``` contactTypes=in=(ADMINISTRATIVE, TECHNICAL) ```
Find all profiles with a first name of Chuck OR a last name of Smith, in ascending order by profile name
``` firstName=="Chuck",lastName=="Smith"&sort=profileName,asc ```
Find all profiles by profile name Foo & Bar (encoded)
``` profileName=="Foo%20%26%20Bar" ```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/dsrecord/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]"
```
Java
```java
package com.cscglobal.dsrecord;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class DSRecordGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/dsrecord/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/dsrecord/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X POST https://apis.cscglobal.com/dbs/api/v2/dsrecord -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Content-Type: application/json" -d @myRequest.txt
```
Java
```java
package com.cscglobal.dsrecord;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DSRecordAdd {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/dsrecord");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/dsrecord"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X DELETE https://apis.cscglobal.com/dbs/api/v2/dsrecord/all -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Content-Type: application/json" -d @dsrecord.txt
```
Java
```java
package com.cscglobal.dsrecord;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DSRecordDelete {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/dsrecord/all");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("DELETE");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Content-Type", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/dsrecord/all"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.delete(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X DELETE https://apis.cscglobal.com/dbs/api/v2/dsrecord/single -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Content-Type: application/json" -d @dsrecord.txt
```
Java
```java
package com.cscglobal.dsrecord;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class DSRecordDelete {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/dsrecord/single");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("DELETE");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Content-Type", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/dsrecord/single"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.delete(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code Examples
CURL
```
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/token/refresh -H \"Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]\" -H \"apikey: [YOUR_API_KEY_HERE]\"
```
Java before 11
```java
package com.cscglobal.token;
import java.net.URL;
import java.net.HttpURLConnection;
import java.IO.IOException;
public class TokenRefresh {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/token/refresh");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Java 11 and beyond
In jshell try:
```jshell
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
import static java.time.temporal.ChronoUnit.SECONDS;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://apis.cscglobal.com/dbs/api/v2/token/refresh"))
.header("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]")
.header("apikey", "[YOUR_API_KEY_HERE]")
.timeout(Duration.of(5, SECONDS))
.PUT(HttpRequest.BodyPublishers.noBody())
.build();
try {
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.discarding());
System.out.printf("%s %s", response.statusCode(), response.body());
} catch (IOException | InterruptedException e) {
throw new RuntimeException(e);
}
```
Python
```
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/token/refresh"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
resp = requests.put(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X GET https://apis.cscglobal.com/dbs/api/v2/urlf/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.urlf;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class UrlfGet {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/urlf/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/urlf/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.get(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X DELETE https://apis.cscglobal.com/dbs/api/v2/urlf/example.com -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.urlf;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class UrlfDelete {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/urlf/example.com");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("DELETE");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/urlf/example.com"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.delete(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X DELETE https://apis.cscglobal.com/dbs/api/v2/example.com/node/node1 -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json"
```
Java
```java
package com.cscglobal.urlf;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
public class UrlfDelete {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/example.com/node/node1");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("DELETE");
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setConnectTimeout(5000);
http.setReadTimeout(5000);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/example.com/node/node1"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
resp = requests.delete(url, headers=headers)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/urlf -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.urlf;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class UrlfAdd {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/urlf");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/urlf"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.put(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Code examples
CURL
```bash
curl -X PUT https://apis.cscglobal.com/dbs/api/v2/urlf/activate -H "Authorization: Bearer [YOUR_BEARER_TOKEN_HERE]" -H "apikey: [YOUR_API_KEY_HERE]" -H "Accept: application/json" -H "Content-Type: application/json" -d "@myRequest.txt"
```
Java
```java
package com.cscglobal.urlf;
import java.net.URL;
import java.net.HttpURLConnection;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
public class UrlfActivate {
public static void main(String[] args) throws IOException {
URL url = new URL("https://apis.cscglobal.com/dbs/api/v2/urlf/activate");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("PUT");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Bearer [YOUR_BEARER_TOKEN_HERE]");
http.setRequestProperty("apikey", "[YOUR_API_KEY_HERE]");
http.setRequestProperty("Accept", "application/json");
http.setRequestProperty("Content-Type", "application/json");
String data = "[YOUR JSON REQUEST HERE]";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();
}
}
```
Python
```python
import requests
from requests.structures import CaseInsensitiveDict
url = "https://apis.cscglobal.com/dbs/api/v2/urlf/activate"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Bearer [YOUR_BEARER_TOKEN_HERE]"
headers["apikey"] = "[YOUR_API_KEY_HERE]"
headers["Accept"] = "application/json"
headers["Content-Type"] = "application/json"
data = "[YOUR JSON REQUEST HERE]"
resp = requests.put(url, headers=headers, data=data)
print(resp.status_code)
print(resp.json())
```
Click to view - All examples exclude the required preceding "filter="
Find all contacts in Germany.
```
filter=countryId==de
```
Find all contacts in Berlin, Germany
```
filter=countryId==de;city==berlin
```
Find all validated contacts in Germany, France or United Kingdom or all contacts in the state
of Wisconsin, USA
```
filter=validated==true;countryId=in=(de,fr,uk),stateProvence==wi;countryId=us
```
Find all Contacts with a firstName like example
```
filter=firstName=like="example\*"
```