# REST API # REST API Guide

This API is currently in beta. New API methods will be added soon.

**Version 0.1 beta.** If you are viewing the REST API guide as a PDF file, you can always check for the latest version here: --- #### Introduction The SafeDNS REST API allows you to automate interactions with your SafeDNS account. It provides methods for retrieving filtering policy information, creating and managing Encrypted DNS devices, and more.
---
#### Description

API address: **https://www.safedns.com/auth/rest\_api/v1/**

---
##### Table of available methods
**\#****Type****Method****Description**
1POST**User authorization**Authorization of the user. Returns user\_id.
2GET**Retrieving a list of filtering policies**Returns a list of all policies created by the user.
3POST**Creating an Encrypted DNS record**Creates an Encrypted DNS device record.
4PATCH**Editing an Encrypted DNS record name**Changes the Encrypted DNS record name.
5DELETE**Deleting an Encrypted DNS record**Deletes the Encrypted DNS record.
6POST**Creating several Encrypted DNS records**Creates several Encrypted DNS records at once.
7GET**Retrieving a list of Encrypted DNS records**Returns a list of all Encrypted DNS records.
--- #### Methods ##### 1. User authorization Authorization of the user. **Request type:** POST **URL:** https://www.safedns.com/auth/rest\_api/v1/login/session/ **Request body:** ```JSON {   "username": "your_login",   "password": "your_password" } ``` The reply contains the **user\_id**. --- ##### 2. Retrieving a list of filtering policies Returns a list of all policies created by the user. **Request type:** GET **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/profiles/ Where {{user\_id}} is the entry retrieved from the Method 1 - User authorization. The reply contains a list of all policies with their respective IDs (**profile\_id**). --- ##### 3. Creating an Encrypted DNS record Creates an Encrypted DNS device record. Mandatory parameters: - user\_id - from Method 1 - User authorization. - profile\_id - from Method 2 - Retrieving a list of filtering policies. **Request type:** POST **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/doh\_device/ **Request body:** ```JSON {   "name": "ANY_ENCRYPTED_DNS_RECORD_NAME",   "profile_id": FILTERING_POLICY_ID } ``` This method creates **a single** Encrypted DNS device at a time. --- ##### 4. Editing an Encrypted DNS record name Changes the Encrypted DNS record name. **Request type:** PATCH **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/doh\_device/{{id\_encrypted\_dns}}/ **Request body:** ```JSON {   "name": "_ENCRYPTED_DNS_RECORD_NAME",   "profile_id": FILTERING_POLICY_ID } ``` --- ##### 5. Deleting an Encrypted DNS record Deletes the Encrypted DNS record. **Request type:** DELETE **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/doh\_device/{{id\_encrypted\_dns}}/ --- ##### 6. Creating several Encrypted DNS records Creates several Encrypted DNS records at once. Mandatory parameters: - user\_id - from Method 1 - User authorization. - profile\_id for each filtering policy you wish to create the record for - from Method 2 - Retrieving a list of filtering policies. **Request type:** POST **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/doh\_device/mass\_create/ **Request body:** ```JSON [   {     "name": "ANY_ENCRYPTED_DNS_RECORD_NAME_1",     "profile_id": FILTERING_POLICY_ID   },   {     "name": "ANY_ENCRYPTED_DNS_RECORD_NAME_2",     "profile_id": FILTERING_POLICY_ID   },   {     "name": "ANY_ENCRYPTED_DNS_RECORD_NAME_3",     "profile_id": FILTERING_POLICY_ID   } ] ``` This method creates **multiple** Encrypted DNS records in a single request. Each record can be assigned the same or a different filtering policy. --- ##### 7. Retrieving a list of Encrypted DNS devices Returns a list of all Encrypted DNS records. **Request type:** GET **URL:** https://safedns.com/dashboard/rest\_api/v1/users/{{user\_id}}/doh\_device/csv/