ParentalApi.md

ParentalApi

Method	HTTP request	Description
parentalDisable	POST /parental/disable	Disable parental filtering
parentalEnable	POST /parental/enable	Enable parental filtering
parentalStatus	GET /parental/status	Get parental filtering status

parentalDisable

void parentalDisable()

Example

import { createConfiguration, ServerConfiguration, ParentalApi } from 'adguardhome';
import * as fs from 'fs';

const configuration = createConfiguration({
    baseServer: new ServerConfiguration("http://adguarghome-ip/control/"),
    authMethods: {
        basicAuth: {
            username: "user",
            password: "pass"
        }
    }
});
const apiInstance = new ParentalApi(configuration);

let body:any = {};

apiInstance.parentalDisable(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

void

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

parentalEnable

void parentalEnable()

Example

import { createConfiguration, ServerConfiguration, ParentalApi } from 'adguardhome';
import * as fs from 'fs';

const configuration = createConfiguration({
    baseServer: new ServerConfiguration("http://adguarghome-ip/control/"),
    authMethods: {
        basicAuth: {
            username: "user",
            password: "pass"
        }
    }
});
const apiInstance = new ParentalApi(configuration);

let body:any = {};

apiInstance.parentalEnable(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

void

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

parentalStatus

ParentalStatus200Response parentalStatus()

Example

import { createConfiguration, ServerConfiguration, ParentalApi } from 'adguardhome';
import * as fs from 'fs';

const configuration = createConfiguration({
    baseServer: new ServerConfiguration("http://adguarghome-ip/control/"),
    authMethods: {
        basicAuth: {
            username: "user",
            password: "pass"
        }
    }
});
const apiInstance = new ParentalApi(configuration);

let body:any = {};

apiInstance.parentalStatus(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ParentalStatus200Response

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]