{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/zones": { "get": { "tags": [ "Zones" ], "operationId": "getZones", "description": "The parameters and request body are for method: getZones. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } } }, "example": [ { "id": "string", "ttl": 1, "nx_ttl": 2, "retry": 2, "zone": "string", "refresh": 7, "expiry": 1, "dns_servers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "networks": [ 4, 9, 1 ], "network_pools": [ "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false }, { "id": "string", "ttl": 2, "nx_ttl": 2, "retry": 7, "zone": "string", "refresh": 8, "expiry": 4, "dns_servers": [ "string" ], "networks": [ 1, 9, 4, 1, 9, 1, 8, 10 ], "network_pools": [ "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": true }, { "id": "string", "ttl": 1, "nx_ttl": 9, "retry": 2, "zone": "string", "refresh": 1, "expiry": 7, "dns_servers": [ "string", "string", "string" ], "networks": [ 5 ], "network_pools": [ "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": true } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/zones/{zone}": { "get": { "tags": [ "Zones" ], "operationId": "getZonesZone", "description": "The parameters and request body are for method: getZonesZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } }, "example": { "id": "string", "ttl": 2, "nx_ttl": 8, "retry": 4, "zone": "string", "refresh": 6, "expiry": 7, "dns_servers": [ "string", "string", "string", "string" ], "networks": [ 10, 1, 10, 2, 1, 1, 6, 8, 6, 1 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Zones" ], "operationId": "postZonesZone", "description": "The parameters and request body are for method: postZonesZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } }, "example": { "id": "string", "ttl": 1, "nx_ttl": 6, "retry": 10, "zone": "string", "refresh": 3, "expiry": 2, "dns_servers": [ "string", "string" ], "networks": [ 1, 8, 9, 10, 10, 5, 2, 9, 4, 2 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "Zones" ], "operationId": "putZonesZone", "description": "The parameters and request body are for method: putZonesZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } }, "example": { "id": "string", "ttl": 3, "nx_ttl": 9, "retry": 6, "zone": "string", "refresh": 5, "expiry": 3, "dns_servers": [ "string", "string", "string", "string", "string", "string" ], "networks": [ 7, 3, 4, 3, 9, 3, 9, 1, 1 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": true } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Zones" ], "operationId": "deleteAZoneAllAssociatedRecords", "description": "The parameters and request body are for method: deleteAZoneAllAssociatedRecords. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/zones/{zone}/dnssec": { "get": { "tags": [ "Zones" ], "operationId": "getZonesZoneDnssec", "description": "The parameters and request body are for method: getZonesZoneDnssec. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/import/zonefile/{zone}": { "get": { "tags": [ "Zones" ], "operationId": "getImportZonefileZone", "description": "The parameters and request body are for method: getImportZonefileZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Zones" ], "operationId": "putImportZonefileZone", "description": "The parameters and request body are for method: putImportZonefileZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } }, "example": { "id": "string", "ttl": 2, "nx_ttl": 9, "retry": 6, "zone": "string", "refresh": 9, "expiry": 6, "dns_servers": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "networks": [ 5 ], "network_pools": [ "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": true } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "async", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/search": { "get": { "tags": [ "Zones" ], "operationId": "getSearch", "description": "The parameters and request body are for method: getSearch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "ttl": { "type": "number" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object" }, "hostmaster": { "type": "string" }, "dnssec": { "type": "boolean" } } } }, "example": [ { "id": "string", "ttl": 5, "nx_ttl": 5, "retry": 10, "zone": "string", "refresh": 7, "expiry": 8, "dns_servers": [ "string", "string" ], "networks": [ 3, 2, 5, 1, 8, 8, 1, 8, 2 ], "network_pools": [ "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false }, { "id": "string", "ttl": 5, "nx_ttl": 1, "retry": 1, "zone": "string", "refresh": 6, "expiry": 2, "dns_servers": [ "string", "string", "string", "string", "string", "string" ], "networks": [ 9, 4, 9, 8, 7, 2, 5, 1, 2 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": true }, { "id": "string", "ttl": 9, "nx_ttl": 4, "retry": 4, "zone": "string", "refresh": 7, "expiry": 8, "dns_servers": [ "string", "string", "string", "string", "string", "string", "string" ], "networks": [ 5 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false }, { "id": "string", "ttl": 9, "nx_ttl": 5, "retry": 1, "zone": "string", "refresh": 9, "expiry": 2, "dns_servers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "networks": [ 4, 9 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "meta": {}, "hostmaster": "string", "dnssec": false } ] } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "max", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/networks": { "get": { "tags": [ "Zones" ], "operationId": "getNetworks", "description": "The parameters and request body are for method: getNetworks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "network_id": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" } } } }, "example": [ { "network_id": "string", "label": "string", "name": "string" }, { "network_id": "string", "label": "string", "name": "string" }, { "network_id": "string", "label": "string", "name": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/zones/{zone}/{domain}/{type}": { "get": { "tags": [ "Records" ], "operationId": "getZonesZoneDomainType", "description": "The parameters and request body are for method: getZonesZoneDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "networks": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" }, "feeds": { "type": "array", "items": { "type": "object" } }, "tier": { "type": "number" }, "customer": { "type": "number" }, "domain": { "type": "string" }, "zone": { "type": "string" }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "answer": { "type": "array", "items": { "type": "string" } } } } }, "regions": { "type": "object" }, "meta": { "type": "object" }, "filters": { "type": "array", "items": { "type": "object" } }, "ttl": { "type": "number" }, "use_client_subnet": { "type": "boolean" } } }, "example": { "id": "string", "networks": [ 2, 1, 3, 7, 7, 8, 6, 4 ], "type": "string", "feeds": [ {}, {} ], "tier": 7, "customer": 10, "domain": "string", "zone": "string", "answers": [ { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string" ] }, { "id": "string", "answer": [ "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string" ] } ], "regions": {}, "meta": {}, "filters": [ {}, {} ], "ttl": 10, "use_client_subnet": true } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Records" ], "operationId": "postZonesZoneDomainType", "description": "The parameters and request body are for method: postZonesZoneDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "networks": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" }, "feeds": { "type": "array", "items": { "type": "object" } }, "tier": { "type": "number" }, "customer": { "type": "number" }, "domain": { "type": "string" }, "zone": { "type": "string" }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "answer": { "type": "array", "items": { "type": "string" } } } } }, "regions": { "type": "object" }, "meta": { "type": "object" }, "filters": { "type": "array", "items": { "type": "object" } }, "ttl": { "type": "number" }, "use_client_subnet": { "type": "boolean" } } }, "example": { "id": "string", "networks": [ 6, 10, 8 ], "type": "string", "feeds": [ {}, {}, {}, {}, {}, {}, {} ], "tier": 3, "customer": 4, "domain": "string", "zone": "string", "answers": [ { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string" ] } ], "regions": {}, "meta": {}, "filters": [ {}, {} ], "ttl": 3, "use_client_subnet": true } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "Records" ], "operationId": "putZonesZoneDomainType", "description": "The parameters and request body are for method: putZonesZoneDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "networks": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" }, "feeds": { "type": "array", "items": { "type": "object" } }, "tier": { "type": "number" }, "customer": { "type": "number" }, "domain": { "type": "string" }, "zone": { "type": "string" }, "answers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "answer": { "type": "array", "items": { "type": "string" } } } } }, "regions": { "type": "object" }, "meta": { "type": "object" }, "filters": { "type": "array", "items": { "type": "object" } }, "ttl": { "type": "number" }, "use_client_subnet": { "type": "boolean" } } }, "example": { "id": "string", "networks": [ 4, 2, 9, 10, 10, 3 ], "type": "string", "feeds": [ {}, {} ], "tier": 10, "customer": 10, "domain": "string", "zone": "string", "answers": [ { "id": "string", "answer": [ "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": "string", "answer": [ "string", "string", "string", "string", "string" ] } ], "regions": {}, "meta": {}, "filters": [ {}, {}, {}, {}, {} ], "ttl": 10, "use_client_subnet": true } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "zone": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" }, "body": { "type": "string" } } }, "example": { "zone": "zone", "domain": "domain", "type": "type", "body": "...body" } } } } }, "delete": { "tags": [ "Records" ], "operationId": "deleteZonesZoneDomainType", "description": "The parameters and request body are for method: deleteZonesZoneDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/metatypes": { "get": { "tags": [ "Records" ], "operationId": "getMetatypes", "description": "The parameters and request body are for method: getMetatypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/filtertypes": { "get": { "tags": [ "Records" ], "operationId": "getFiltertypes", "description": "The parameters and request body are for method: getFiltertypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/metatypes/geo": { "get": { "tags": [ "Records" ], "operationId": "getMetatypesGeo", "description": "The parameters and request body are for method: getMetatypesGeo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/data/sourcetypes": { "get": { "tags": [ "DataSources" ], "operationId": "viewAvailableDataSourcesTypes", "description": "The parameters and request body are for method: viewAvailableDataSourcesTypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/data/sources": { "get": { "tags": [ "DataSources" ], "operationId": "getDataSources", "description": "The parameters and request body are for method: getDataSources. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "sourcetype": { "type": "string" }, "id": { "type": "string" }, "config": { "type": "object", "properties": { "api_key": { "type": "string" }, "secret_key": { "type": "string" }, "webhook_token": { "type": "string" } } }, "feeds": { "type": "array", "items": { "type": "object" } }, "name": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "sourcetype": "string", "id": "string", "config": { "api_key": "string", "secret_key": "string", "webhook_token": "string" }, "feeds": [ {}, {}, {}, {}, {} ], "name": "string", "status": "string" }, { "sourcetype": "string", "id": "string", "config": { "api_key": "string", "secret_key": "string", "webhook_token": "string" }, "feeds": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "name": "string", "status": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "DataSources" ], "operationId": "putDataSources", "description": "The parameters and request body are for method: putDataSources. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "sourcetype": { "type": "string" }, "id": { "type": "string" }, "config": { "type": "object", "properties": { "api_key": { "type": "string" }, "secret_key": { "type": "string" }, "webhook_token": { "type": "string" } } }, "feeds": { "type": "array", "items": { "type": "object" } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "example": { "sourcetype": "string", "id": "string", "config": { "api_key": "string", "secret_key": "string", "webhook_token": "string" }, "feeds": [ {}, {}, {}, {}, {} ], "name": "string", "status": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "config" } } } } }, "/data/sources/{sourceid}": { "get": { "tags": [ "DataSources" ], "operationId": "getDataSourcesSourceid", "description": "The parameters and request body are for method: getDataSourcesSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "sourcetype": { "type": "string" }, "id": { "type": "string" }, "config": { "type": "object", "properties": { "api_key": { "type": "string" }, "secret_key": { "type": "string" }, "webhook_token": { "type": "string" } } }, "feeds": { "type": "array", "items": { "type": "object" } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "example": { "sourcetype": "string", "id": "string", "config": { "api_key": "string", "secret_key": "string", "webhook_token": "string" }, "feeds": [ {}, {}, {}, {}, {} ], "name": "string", "status": "string" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "DataSources" ], "operationId": "postDataSourcesSourceid", "description": "The parameters and request body are for method: postDataSourcesSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "sourcetype": { "type": "string" }, "id": { "type": "string" }, "config": { "type": "object", "properties": { "api_key": { "type": "string" }, "secret_key": { "type": "string" }, "webhook_token": { "type": "string" } } }, "feeds": { "type": "array", "items": { "type": "object" } }, "name": { "type": "string" }, "status": { "type": "string" } } }, "example": { "sourcetype": "string", "id": "string", "config": { "api_key": "string", "secret_key": "string", "webhook_token": "string" }, "feeds": [ {} ], "name": "string", "status": "string" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "DataSources" ], "operationId": "deleteDataSourcesSourceid", "description": "The parameters and request body are for method: deleteDataSourcesSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/data/feeds/{sourceid}": { "get": { "tags": [ "DataFeeds" ], "operationId": "getDataFeedsSourceid", "description": "The parameters and request body are for method: getDataFeedsSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "destid": { "type": "string" }, "desttype": { "type": "string" }, "record": { "type": "string" } } } }, "id": { "type": "string" }, "data": { "type": "object", "properties": { "up": { "type": "string" } } }, "config": { "type": "object", "properties": { "label": { "type": "string" } } }, "name": { "type": "string" } } } }, "example": [ { "destinations": [ { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" } ], "id": "string", "data": { "up": "string" }, "config": { "label": "string" }, "name": "string" } ] } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "DataFeeds" ], "operationId": "postDataFeedsSourceid", "description": "The parameters and request body are for method: postDataFeedsSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "DataFeeds" ], "operationId": "putDataFeedsSourceid", "description": "The parameters and request body are for method: putDataFeedsSourceid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "destid": { "type": "string" }, "desttype": { "type": "string" }, "record": { "type": "string" } } } }, "id": { "type": "string" }, "data": { "type": "object", "properties": { "up": { "type": "string" } } }, "config": { "type": "object", "properties": { "label": { "type": "string" } } }, "name": { "type": "string" } } }, "example": { "destinations": [ { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" } ], "id": "string", "data": { "up": "string" }, "config": { "label": "string" }, "name": "string" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/data/feeds/{sourceid}/{feedid}": { "get": { "tags": [ "DataFeeds" ], "operationId": "getDataFeedsSourceidFeedid", "description": "The parameters and request body are for method: getDataFeedsSourceidFeedid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "destid": { "type": "string" }, "desttype": { "type": "string" }, "record": { "type": "string" } } } }, "id": { "type": "string" }, "data": { "type": "object", "properties": { "up": { "type": "string" } } }, "config": { "type": "object", "properties": { "label": { "type": "string" } } }, "name": { "type": "string" } } }, "example": { "destinations": [ { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" } ], "id": "string", "data": { "up": "string" }, "config": { "label": "string" }, "name": "string" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } }, { "name": "feedid", "in": "path", "required": true, "schema": { "title": "feedid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "DataFeeds" ], "operationId": "modifyADataFeed", "description": "The parameters and request body are for method: modifyADataFeed. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "destid": { "type": "string" }, "desttype": { "type": "string" }, "record": { "type": "string" } } } }, "id": { "type": "string" }, "data": { "type": "object", "properties": { "up": { "type": "string" } } }, "config": { "type": "object", "properties": { "label": { "type": "string" } } }, "name": { "type": "string" } } }, "example": { "destinations": [ { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" } ], "id": "string", "data": { "up": "string" }, "config": { "label": "string" }, "name": "string" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } }, { "name": "feedid", "in": "path", "required": true, "schema": { "title": "feedid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "dataFeed" } } } }, "delete": { "tags": [ "DataFeeds" ], "operationId": "deleteDataFeedsSourceidFeedid", "description": "The parameters and request body are for method: deleteDataFeedsSourceidFeedid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "sourceid", "in": "path", "required": true, "schema": { "title": "sourceid", "type": "string" } }, { "name": "feedid", "in": "path", "required": true, "schema": { "title": "feedid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/monitoring/jobs": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringJobs", "description": "The parameters and request body are for method: getMonitoringJobs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "object", "properties": { "global": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } }, "ams": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } } } }, "notes": { "type": "object" }, "policy": { "type": "string" }, "frequency": { "type": "number" }, "regions": { "type": "array", "items": { "type": "string" } }, "region_scope": { "type": "string" }, "active": { "type": "boolean" }, "rapid_recheck": { "type": "boolean" }, "name": { "type": "string" }, "job_type": { "type": "string" }, "config": { "type": "object", "properties": { "ssl": { "type": "string" }, "send": { "type": "string" }, "port": { "type": "number" }, "host": { "type": "string" } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "comparison": { "type": "string" }, "key": { "type": "string" } } } }, "notify_delay": { "type": "number" }, "notify_repeat": { "type": "number" }, "notify_failback": { "type": "boolean" }, "notify_regional": { "type": "boolean" }, "notify_list": { "type": "object" }, "id": { "type": "string" } } } }, "example": [ { "status": { "global": { "since": 8, "status": "string" }, "ams": { "since": 2, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 4, "regions": [ "string", "string" ], "region_scope": "string", "active": false, "rapid_recheck": true, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 6, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 6, "notify_repeat": 9, "notify_failback": true, "notify_regional": false, "notify_list": {}, "id": "string" }, { "status": { "global": { "since": 5, "status": "string" }, "ams": { "since": 10, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 8, "regions": [ "string", "string", "string", "string" ], "region_scope": "string", "active": true, "rapid_recheck": false, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 4, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 1, "notify_repeat": 8, "notify_failback": true, "notify_regional": true, "notify_list": {}, "id": "string" }, { "status": { "global": { "since": 4, "status": "string" }, "ams": { "since": 6, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 4, "regions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "region_scope": "string", "active": false, "rapid_recheck": true, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 1, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 6, "notify_repeat": 4, "notify_failback": false, "notify_regional": false, "notify_list": {}, "id": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "MonitoringJobs" ], "operationId": "putMonitoringJobs", "description": "The parameters and request body are for method: putMonitoringJobs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "global": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } }, "ams": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } } } }, "notes": { "type": "object" }, "policy": { "type": "string" }, "frequency": { "type": "number" }, "regions": { "type": "array", "items": { "type": "string" } }, "region_scope": { "type": "string" }, "active": { "type": "boolean" }, "rapid_recheck": { "type": "boolean" }, "name": { "type": "string" }, "job_type": { "type": "string" }, "config": { "type": "object", "properties": { "ssl": { "type": "string" }, "send": { "type": "string" }, "port": { "type": "number" }, "host": { "type": "string" } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "comparison": { "type": "string" }, "key": { "type": "string" } } } }, "notify_delay": { "type": "number" }, "notify_repeat": { "type": "number" }, "notify_failback": { "type": "boolean" }, "notify_regional": { "type": "boolean" }, "notify_list": { "type": "object" }, "id": { "type": "string" } } }, "example": { "status": { "global": { "since": 2, "status": "string" }, "ams": { "since": 10, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 5, "regions": [ "string" ], "region_scope": "string", "active": false, "rapid_recheck": false, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 2, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 8, "notify_repeat": 8, "notify_failback": true, "notify_regional": true, "notify_list": {}, "id": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/monitoring/jobs/{jobid}": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringJobsJobid", "description": "The parameters and request body are for method: getMonitoringJobsJobid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "global": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } }, "ams": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } } } }, "notes": { "type": "object" }, "policy": { "type": "string" }, "frequency": { "type": "number" }, "regions": { "type": "array", "items": { "type": "string" } }, "region_scope": { "type": "string" }, "active": { "type": "boolean" }, "rapid_recheck": { "type": "boolean" }, "name": { "type": "string" }, "job_type": { "type": "string" }, "config": { "type": "object", "properties": { "ssl": { "type": "string" }, "send": { "type": "string" }, "port": { "type": "number" }, "host": { "type": "string" } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "comparison": { "type": "string" }, "key": { "type": "string" } } } }, "notify_delay": { "type": "number" }, "notify_repeat": { "type": "number" }, "notify_failback": { "type": "boolean" }, "notify_regional": { "type": "boolean" }, "notify_list": { "type": "object" }, "id": { "type": "string" } } }, "example": { "status": { "global": { "since": 7, "status": "string" }, "ams": { "since": 2, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 10, "regions": [ "string", "string" ], "region_scope": "string", "active": true, "rapid_recheck": true, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 10, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 10, "notify_repeat": 6, "notify_failback": true, "notify_regional": false, "notify_list": {}, "id": "string" } } } } }, "parameters": [ { "name": "jobid", "in": "path", "required": true, "schema": { "title": "jobid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "MonitoringJobs" ], "operationId": "postMonitoringJobsJobid", "description": "The parameters and request body are for method: postMonitoringJobsJobid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "global": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } }, "ams": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } } } }, "notes": { "type": "object" }, "policy": { "type": "string" }, "frequency": { "type": "number" }, "regions": { "type": "array", "items": { "type": "string" } }, "region_scope": { "type": "string" }, "active": { "type": "boolean" }, "rapid_recheck": { "type": "boolean" }, "name": { "type": "string" }, "job_type": { "type": "string" }, "config": { "type": "object", "properties": { "ssl": { "type": "string" }, "send": { "type": "string" }, "port": { "type": "number" }, "host": { "type": "string" } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "comparison": { "type": "string" }, "key": { "type": "string" } } } }, "notify_delay": { "type": "number" }, "notify_repeat": { "type": "number" }, "notify_failback": { "type": "boolean" }, "notify_regional": { "type": "boolean" }, "notify_list": { "type": "object" }, "id": { "type": "string" } } }, "example": { "status": { "global": { "since": 5, "status": "string" }, "ams": { "since": 7, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 10, "regions": [ "string", "string", "string", "string" ], "region_scope": "string", "active": false, "rapid_recheck": false, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 4, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 10, "notify_repeat": 1, "notify_failback": true, "notify_regional": false, "notify_list": {}, "id": "string" } } } } }, "parameters": [ { "name": "jobid", "in": "path", "required": true, "schema": { "title": "jobid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } }, "delete": { "tags": [ "MonitoringJobs" ], "operationId": "removeAMonitoringJob", "description": "The parameters and request body are for method: removeAMonitoringJob. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "jobid", "in": "path", "required": true, "schema": { "title": "jobid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/monitoring/history/{jobid}": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringHistoryJobid", "description": "The parameters and request body are for method: getMonitoringHistoryJobid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "object", "properties": { "global": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } }, "ams": { "type": "object", "properties": { "since": { "type": "number" }, "status": { "type": "string" } } } } }, "notes": { "type": "object" }, "policy": { "type": "string" }, "frequency": { "type": "number" }, "regions": { "type": "array", "items": { "type": "string" } }, "region_scope": { "type": "string" }, "active": { "type": "boolean" }, "rapid_recheck": { "type": "boolean" }, "name": { "type": "string" }, "job_type": { "type": "string" }, "config": { "type": "object", "properties": { "ssl": { "type": "string" }, "send": { "type": "string" }, "port": { "type": "number" }, "host": { "type": "string" } } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "comparison": { "type": "string" }, "key": { "type": "string" } } } }, "notify_delay": { "type": "number" }, "notify_repeat": { "type": "number" }, "notify_failback": { "type": "boolean" }, "notify_regional": { "type": "boolean" }, "notify_list": { "type": "object" }, "id": { "type": "string" } } } }, "example": [ { "status": { "global": { "since": 6, "status": "string" }, "ams": { "since": 7, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 1, "regions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "region_scope": "string", "active": true, "rapid_recheck": true, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 4, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 1, "notify_repeat": 2, "notify_failback": true, "notify_regional": false, "notify_list": {}, "id": "string" }, { "status": { "global": { "since": 1, "status": "string" }, "ams": { "since": 8, "status": "string" } }, "notes": {}, "policy": "string", "frequency": 2, "regions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "region_scope": "string", "active": true, "rapid_recheck": false, "name": "string", "job_type": "string", "config": { "ssl": "string", "send": "string", "port": 7, "host": "string" }, "rules": [ { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" }, { "value": "string", "comparison": "string", "key": "string" } ], "notify_delay": 10, "notify_repeat": 9, "notify_failback": false, "notify_regional": true, "notify_list": {}, "id": "string" } ] } } } }, "parameters": [ { "name": "jobid", "in": "path", "required": true, "schema": { "title": "jobid", "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "exact", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/monitoring/metric/{jobid}": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringMetricJobid", "description": "The parameters and request body are for method: getMonitoringMetricJobid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "jobid": { "type": "string" }, "region": { "type": "string" }, "metrics": { "type": "object", "properties": { "rtt": { "type": "object", "properties": { "avg": { "type": "string" }, "graph": { "type": "array", "items": { "type": "number" } } } } } } } } }, "example": [ { "jobid": "string", "region": "string", "metrics": { "rtt": { "avg": "string", "graph": [ 5, 6, 5 ] } } } ] } } } }, "parameters": [ { "name": "jobid", "in": "path", "required": true, "schema": { "title": "jobid", "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/monitoring/jobtypes": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringJobtypes", "description": "The parameters and request body are for method: getMonitoringJobtypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "tcp": { "type": "object", "properties": { "desc": { "type": "string" }, "results": { "type": "object", "properties": { "connect": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "metric": { "type": "boolean" }, "comparators": { "type": "array", "items": { "type": "object" } } } }, "output": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "metric": { "type": "boolean" }, "comparators": { "type": "array", "items": { "type": "object" } } } } } }, "config": { "type": "object", "properties": { "port": { "type": "object", "properties": { "validator": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "desc": { "type": "string" }, "shortdesc": { "type": "string" } } }, "host": { "type": "object", "properties": { "validator": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "desc": { "type": "string" }, "shortdesc": { "type": "string" } } }, "ssl": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "boolean" } } }, "connect_timeout": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "number" } } }, "send": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "object" } } }, "response_timeout": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "number" } } } } }, "shortdesc": { "type": "string" } } }, "ping": { "type": "object", "properties": { "desc": { "type": "string" }, "results": { "type": "object", "properties": { "loss": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "metric": { "type": "boolean" }, "comparators": { "type": "array", "items": { "type": "object" } } } }, "rtt": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "metric": { "type": "boolean" }, "comparators": { "type": "array", "items": { "type": "object" } } } } } }, "config": { "type": "object", "properties": { "timeout": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "number" } } }, "interval": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "number" } } }, "host": { "type": "object", "properties": { "validator": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "desc": { "type": "string" }, "shortdesc": { "type": "string" } } }, "count": { "type": "object", "properties": { "desc": { "type": "string" }, "type": { "type": "string" }, "shortdesc": { "type": "string" }, "validator": { "type": "string" }, "required": { "type": "boolean" }, "default": { "type": "number" } } } } }, "shortdesc": { "type": "string" } } } } }, "example": { "tcp": { "desc": "string", "results": { "connect": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "metric": false, "comparators": [ {}, {}, {}, {}, {}, {} ] }, "output": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "metric": true, "comparators": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] } }, "config": { "port": { "validator": "string", "type": "string", "required": false, "desc": "string", "shortdesc": "string" }, "host": { "validator": "string", "type": "string", "required": true, "desc": "string", "shortdesc": "string" }, "ssl": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": true, "default": true }, "connect_timeout": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": false, "default": 2 }, "send": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": true, "default": null }, "response_timeout": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": true, "default": 1 } }, "shortdesc": "string" }, "ping": { "desc": "string", "results": { "loss": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "metric": false, "comparators": [ {}, {}, {}, {}, {}, {} ] }, "rtt": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "metric": false, "comparators": [ {}, {}, {}, {}, {} ] } }, "config": { "timeout": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": false, "default": 2 }, "interval": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": true, "default": 9 }, "host": { "validator": "string", "type": "string", "required": false, "desc": "string", "shortdesc": "string" }, "count": { "desc": "string", "type": "string", "shortdesc": "string", "validator": "string", "required": true, "default": 1 } }, "shortdesc": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/monitoring/regions": { "get": { "tags": [ "MonitoringJobs" ], "operationId": "getMonitoringRegions", "description": "The parameters and request body are for method: getMonitoringRegions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "subnets": { "type": "array", "items": { "type": "string" } } } } }, "example": [ { "name": "string", "code": "string", "subnets": [ "string" ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/lists": { "get": { "tags": [ "NotificationLists" ], "operationId": "getLists", "description": "The parameters and request body are for method: getLists. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "notify_list": { "type": "array", "items": { "type": "object", "properties": { "config": { "type": "object", "properties": { "email": { "type": "string" } } }, "type": { "type": "string" } } } } } } }, "example": [ { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] }, { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] }, { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "NotificationLists" ], "operationId": "putLists", "description": "The parameters and request body are for method: putLists. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "notify_list": { "type": "array", "items": { "type": "object", "properties": { "config": { "type": "object", "properties": { "email": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "example": { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "list": { "type": "string" } } }, "example": { "list": "list" } } } } } }, "/lists/{listid}": { "get": { "tags": [ "NotificationLists" ], "operationId": "getListsListid", "description": "The parameters and request body are for method: getListsListid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "notify_list": { "type": "array", "items": { "type": "object", "properties": { "config": { "type": "object", "properties": { "email": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "example": { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] } } } } }, "parameters": [ { "name": "listid", "in": "path", "required": true, "schema": { "title": "listid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "NotificationLists" ], "operationId": "postListsListid", "description": "The parameters and request body are for method: postListsListid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "notify_list": { "type": "array", "items": { "type": "object", "properties": { "config": { "type": "object", "properties": { "email": { "type": "string" } } }, "type": { "type": "string" } } } } } }, "example": { "id": "string", "name": "string", "notify_list": [ { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" }, { "config": { "email": "string" }, "type": "string" } ] } } } } }, "parameters": [ { "name": "listid", "in": "path", "required": true, "schema": { "title": "listid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "list" } } } }, "delete": { "tags": [ "NotificationLists" ], "operationId": "deleteListsListid", "description": "The parameters and request body are for method: deleteListsListid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "listid", "in": "path", "required": true, "schema": { "title": "listid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/notifytypes": { "get": { "tags": [ "NotificationLists" ], "operationId": "getNotifytypes", "description": "The parameters and request body are for method: getNotifytypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object" }, "email": { "type": "object" }, "datafeed": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "destid": { "type": "string" }, "desttype": { "type": "string" }, "record": { "type": "string" } } } }, "id": { "type": "string" }, "data": { "type": "object", "properties": { "up": { "type": "string" } } }, "config": { "type": "object", "properties": { "label": { "type": "string" } } }, "name": { "type": "string" } } } } }, "example": { "user": {}, "email": {}, "datafeed": { "destinations": [ { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" }, { "destid": "string", "desttype": "string", "record": "string" } ], "id": "string", "data": { "up": "string" }, "config": { "label": "string" }, "name": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/settings": { "get": { "tags": [ "AccountManagementGeneral" ], "operationId": "getAccountSettings", "description": "The parameters and request body are for method: getAccountSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalcode": { "type": "string" } } }, "phone": { "type": "string" }, "customerid": { "type": "number" }, "company": { "type": "string" }, "lastname": { "type": "string" }, "firstname": { "type": "string" } } }, "example": { "email": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "phone": "string", "customerid": 7, "company": "string", "lastname": "string", "firstname": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementGeneral" ], "operationId": "postAccountSettings", "description": "The parameters and request body are for method: postAccountSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalcode": { "type": "string" } } }, "phone": { "type": "string" }, "customerid": { "type": "number" }, "company": { "type": "string" }, "lastname": { "type": "string" }, "firstname": { "type": "string" } } }, "example": { "email": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "phone": "string", "customerid": 4, "company": "string", "lastname": "string", "firstname": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "accountDetails" } } } } }, "/account/usagewarnings": { "get": { "tags": [ "AccountManagementGeneral" ], "operationId": "getAccountUsagewarnings", "description": "The parameters and request body are for method: getAccountUsagewarnings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "queries": { "type": "object", "properties": { "send_warnings": { "type": "boolean" }, "warning_2": { "type": "number" }, "warning_1": { "type": "number" } } }, "records": { "type": "object", "properties": { "send_warnings": { "type": "boolean" }, "warning_2": { "type": "number" }, "warning_1": { "type": "number" } } } } }, "example": { "queries": { "send_warnings": true, "warning_2": 5, "warning_1": 10 }, "records": { "send_warnings": true, "warning_2": 4, "warning_1": 9 } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementGeneral" ], "operationId": "postAccountUsagewarnings", "description": "The parameters and request body are for method: postAccountUsagewarnings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "queries": { "type": "object", "properties": { "send_warnings": { "type": "boolean" }, "warning_2": { "type": "number" }, "warning_1": { "type": "number" } } }, "records": { "type": "object", "properties": { "send_warnings": { "type": "boolean" }, "warning_2": { "type": "number" }, "warning_1": { "type": "number" } } } } }, "example": { "queries": { "send_warnings": false, "warning_2": 10, "warning_1": 10 }, "records": { "send_warnings": true, "warning_2": 8, "warning_1": 3 } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "accountDetails" } } } } }, "/account/users": { "get": { "tags": [ "AccountManagementUser" ], "operationId": "getAccountUsers", "description": "The parameters and request body are for method: getAccountUsers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow_by_default": { "type": "boolean" }, "zones_deny": { "type": "array", "items": { "type": "object" } }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "email": { "type": "string" }, "last_access": { "type": "object" }, "notify": { "type": "object", "properties": { "billing": { "type": "boolean" } } }, "name": { "type": "string" }, "username": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } } }, "example": [ { "permissions": { "dns": { "view_zones": true, "manage_zones": true, "zones_allow_by_default": false, "zones_deny": [ {}, {}, {}, {}, {}, {}, {}, {} ], "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": false, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": false, "manage_teams": true, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": true, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": true, "manage_jobs": false, "view_jobs": false } }, "teams": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "email": "string", "last_access": null, "notify": { "billing": false }, "name": "string", "username": "string", "ip_whitelist_strict": true, "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/users/{username}": { "get": { "tags": [ "AccountManagementUser" ], "operationId": "getAccountUsersUsername", "description": "The parameters and request body are for method: getAccountUsersUsername. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow_by_default": { "type": "boolean" }, "zones_deny": { "type": "array", "items": { "type": "object" } }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "email": { "type": "string" }, "last_access": { "type": "object" }, "notify": { "type": "object", "properties": { "billing": { "type": "boolean" } } }, "name": { "type": "string" }, "username": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "view_zones": true, "manage_zones": true, "zones_allow_by_default": true, "zones_deny": [ {}, {} ], "zones_allow": [ {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": true, "manage_datafeeds": true }, "account": { "manage_payment_methods": false, "manage_plan": true, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": true, "view_activity_log": true, "view_invoices": true, "manage_users": true }, "monitoring": { "manage_lists": true, "manage_jobs": false, "view_jobs": true } }, "teams": [ {} ], "email": "string", "last_access": null, "notify": { "billing": false }, "name": "string", "username": "string", "ip_whitelist_strict": true, "ip_whitelist": [ {} ] } } } } }, "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "title": "username", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementUser" ], "operationId": "updateAUserSDetails", "description": "The parameters and request body are for method: updateAUserSDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow_by_default": { "type": "boolean" }, "zones_deny": { "type": "array", "items": { "type": "object" } }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "email": { "type": "string" }, "last_access": { "type": "object" }, "notify": { "type": "object", "properties": { "billing": { "type": "boolean" } } }, "name": { "type": "string" }, "username": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "view_zones": true, "manage_zones": true, "zones_allow_by_default": false, "zones_deny": [ {}, {} ], "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": false, "manage_datafeeds": false }, "account": { "manage_payment_methods": false, "manage_plan": false, "manage_teams": true, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": true, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": false, "manage_jobs": true, "view_jobs": true } }, "teams": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "email": "string", "last_access": null, "notify": { "billing": true }, "name": "string", "username": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {} ] } } } } }, "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "title": "username", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "put": { "tags": [ "AccountManagementUser" ], "operationId": "addUserToAccount", "description": "The parameters and request body are for method: addUserToAccount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow_by_default": { "type": "boolean" }, "zones_deny": { "type": "array", "items": { "type": "object" } }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "email": { "type": "string" }, "last_access": { "type": "object" }, "notify": { "type": "object", "properties": { "billing": { "type": "boolean" } } }, "name": { "type": "string" }, "username": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "view_zones": false, "manage_zones": true, "zones_allow_by_default": false, "zones_deny": [ {}, {}, {}, {}, {}, {} ], "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": true, "manage_datafeeds": false }, "account": { "manage_payment_methods": true, "manage_plan": true, "manage_teams": true, "manage_apikeys": true, "manage_account_settings": false, "view_activity_log": true, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": true, "manage_jobs": true, "view_jobs": false } }, "teams": [ {}, {}, {}, {} ], "email": "string", "last_access": null, "notify": { "billing": false }, "name": "string", "username": "string", "ip_whitelist_strict": true, "ip_whitelist": [ {}, {}, {} ] } } } } }, "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "title": "username", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "AccountManagementUser" ], "operationId": "deleteAccountUsersUsername", "description": "The parameters and request body are for method: deleteAccountUsersUsername. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "title": "username", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/reinvite/{username}": { "post": { "tags": [ "AccountManagementUser" ], "operationId": "postAccountReinviteUsername", "description": "The parameters and request body are for method: postAccountReinviteUsername. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "title": "username", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "user" } } } } }, "/account/apikeys": { "get": { "tags": [ "AccountManagementAPIKey" ], "operationId": "getAccountApikeys", "description": "The parameters and request body are for method: getAccountApikeys. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "last_access": { "type": "object" }, "key": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } } }, "example": [ { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": false, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": false, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": false, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": true, "manage_jobs": false, "view_jobs": true } }, "teams": [ {}, {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": true, "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {}, {} ] }, { "permissions": { "dns": { "zones_allow_by_default": true, "view_zones": false, "manage_zones": true, "zones_allow": [ {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": true, "manage_datafeeds": false }, "account": { "manage_payment_methods": false, "manage_plan": true, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": false, "view_invoices": false, "manage_users": false }, "monitoring": { "manage_lists": false, "manage_jobs": false, "view_jobs": true } }, "teams": [ {}, {}, {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {}, {}, {}, {} ] }, { "permissions": { "dns": { "zones_allow_by_default": true, "view_zones": true, "manage_zones": false, "zones_allow": [ {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": false, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": false, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": true, "view_activity_log": true, "view_invoices": true, "manage_users": true }, "monitoring": { "manage_lists": true, "manage_jobs": true, "view_jobs": false } }, "teams": [ {}, {}, {}, {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "AccountManagementAPIKey" ], "operationId": "putAccountApikeys", "description": "The parameters and request body are for method: putAccountApikeys. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "last_access": { "type": "object" }, "key": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": true, "view_zones": true, "manage_zones": false, "zones_allow": [ {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": true, "manage_datafeeds": false }, "account": { "manage_payment_methods": false, "manage_plan": true, "manage_teams": false, "manage_apikeys": true, "manage_account_settings": true, "view_activity_log": true, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": false, "manage_jobs": false, "view_jobs": false } }, "teams": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {}, {}, {}, {} ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "key" } } } } }, "/account/apikeys/{keyid}": { "get": { "tags": [ "AccountManagementAPIKey" ], "operationId": "getAccountApikeysKeyid", "description": "The parameters and request body are for method: getAccountApikeysKeyid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "last_access": { "type": "object" }, "key": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": false, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": true, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": true, "manage_teams": true, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": true, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": false, "manage_jobs": true, "view_jobs": true } }, "teams": [ {}, {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {}, {}, {}, {}, {}, {} ] } } } } }, "parameters": [ { "name": "keyid", "in": "path", "required": true, "schema": { "title": "keyid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementAPIKey" ], "operationId": "postAccountApikeysKeyid", "description": "The parameters and request body are for method: postAccountApikeysKeyid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "teams": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "last_access": { "type": "object" }, "key": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist_strict": { "type": "boolean" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": false, "zones_allow": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": true, "manage_datafeeds": true }, "account": { "manage_payment_methods": false, "manage_plan": true, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": false, "view_activity_log": true, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": false, "manage_jobs": true, "view_jobs": false } }, "teams": [ {}, {}, {} ], "id": "string", "last_access": null, "key": "string", "name": "string", "ip_whitelist_strict": false, "ip_whitelist": [ {} ] } } } } }, "parameters": [ { "name": "keyid", "in": "path", "required": true, "schema": { "title": "keyid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "key" } } } }, "delete": { "tags": [ "AccountManagementAPIKey" ], "operationId": "deleteAnAPIKey", "description": "The parameters and request body are for method: deleteAnAPIKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "keyid", "in": "path", "required": true, "schema": { "title": "keyid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/teams": { "get": { "tags": [ "AccountManagementTeam" ], "operationId": "getAccountTeams", "description": "The parameters and request body are for method: getAccountTeams. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "id": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } } }, "example": [ { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": false, "zones_allow": [ {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": false, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": true, "manage_teams": true, "manage_apikeys": true, "manage_account_settings": true, "view_activity_log": false, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": true, "manage_jobs": true, "view_jobs": true } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, { "permissions": { "dns": { "zones_allow_by_default": true, "view_zones": true, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": true, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": true, "manage_teams": false, "manage_apikeys": false, "manage_account_settings": true, "view_activity_log": false, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": true, "manage_jobs": true, "view_jobs": false } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {}, {} ] }, { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": false, "zones_allow": [ {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": false, "manage_datafeeds": false }, "account": { "manage_payment_methods": false, "manage_plan": false, "manage_teams": true, "manage_apikeys": true, "manage_account_settings": false, "view_activity_log": true, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": false, "manage_jobs": false, "view_jobs": false } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {}, {} ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "AccountManagementTeam" ], "operationId": "putAccountTeams", "description": "The parameters and request body are for method: putAccountTeams. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "id": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": true, "view_zones": true, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": true, "manage_datafeeds": true }, "account": { "manage_payment_methods": true, "manage_plan": true, "manage_teams": true, "manage_apikeys": true, "manage_account_settings": true, "view_activity_log": true, "view_invoices": false, "manage_users": true }, "monitoring": { "manage_lists": true, "manage_jobs": true, "view_jobs": true } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {} ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "team" } } } } }, "/account/teams/{teamid}": { "get": { "tags": [ "AccountManagementTeam" ], "operationId": "getAccountTeamsTeamid", "description": "The parameters and request body are for method: getAccountTeamsTeamid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "id": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": true, "manage_datasources": false, "manage_datafeeds": false }, "account": { "manage_payment_methods": false, "manage_plan": true, "manage_teams": true, "manage_apikeys": false, "manage_account_settings": true, "view_activity_log": false, "view_invoices": true, "manage_users": false }, "monitoring": { "manage_lists": true, "manage_jobs": false, "view_jobs": false } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {} ] } } } } }, "parameters": [ { "name": "teamid", "in": "path", "required": true, "schema": { "title": "teamid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementTeam" ], "operationId": "postAccountTeamsTeamid", "description": "The parameters and request body are for method: postAccountTeamsTeamid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "object", "properties": { "dns": { "type": "object", "properties": { "zones_allow_by_default": { "type": "boolean" }, "view_zones": { "type": "boolean" }, "manage_zones": { "type": "boolean" }, "zones_allow": { "type": "array", "items": { "type": "object" } } } }, "data": { "type": "object", "properties": { "push_to_datafeeds": { "type": "boolean" }, "manage_datasources": { "type": "boolean" }, "manage_datafeeds": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "manage_payment_methods": { "type": "boolean" }, "manage_plan": { "type": "boolean" }, "manage_teams": { "type": "boolean" }, "manage_apikeys": { "type": "boolean" }, "manage_account_settings": { "type": "boolean" }, "view_activity_log": { "type": "boolean" }, "view_invoices": { "type": "boolean" }, "manage_users": { "type": "boolean" } } }, "monitoring": { "type": "object", "properties": { "manage_lists": { "type": "boolean" }, "manage_jobs": { "type": "boolean" }, "view_jobs": { "type": "boolean" } } } } }, "id": { "type": "string" }, "name": { "type": "string" }, "ip_whitelist": { "type": "array", "items": { "type": "object" } } } }, "example": { "permissions": { "dns": { "zones_allow_by_default": false, "view_zones": true, "manage_zones": true, "zones_allow": [ {}, {}, {}, {}, {} ] }, "data": { "push_to_datafeeds": false, "manage_datasources": true, "manage_datafeeds": false }, "account": { "manage_payment_methods": true, "manage_plan": false, "manage_teams": true, "manage_apikeys": false, "manage_account_settings": true, "view_activity_log": false, "view_invoices": true, "manage_users": true }, "monitoring": { "manage_lists": false, "manage_jobs": false, "view_jobs": true } }, "id": "string", "name": "string", "ip_whitelist": [ {}, {}, {}, {}, {}, {}, {} ] } } } } }, "parameters": [ { "name": "teamid", "in": "path", "required": true, "schema": { "title": "teamid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "team" } } } }, "delete": { "tags": [ "AccountManagementTeam" ], "operationId": "deleteAccountTeamsTeamid", "description": "The parameters and request body are for method: deleteAccountTeamsTeamid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "teamid", "in": "path", "required": true, "schema": { "title": "teamid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/whitelist": { "get": { "tags": [ "AccountManagementIPWhitelist" ], "operationId": "getAccountWhitelist", "description": "The parameters and request body are for method: getAccountWhitelist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object" } } } } }, "example": [ { "id": "string", "name": "string", "values": [ {}, {}, {}, {}, {}, {}, {} ] }, { "id": "string", "name": "string", "values": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "AccountManagementIPWhitelist" ], "operationId": "putAccountWhitelist", "description": "The parameters and request body are for method: putAccountWhitelist. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "string", "name": "string", "values": [ {}, {} ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "whitelist" } } } } }, "/account/whitelist/{id}": { "get": { "tags": [ "AccountManagementIPWhitelist" ], "operationId": "getAccountWhitelistId", "description": "The parameters and request body are for method: getAccountWhitelistId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "string", "name": "string", "values": [ {}, {} ] } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementIPWhitelist" ], "operationId": "postAccountWhitelistId", "description": "The parameters and request body are for method: postAccountWhitelistId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "string", "name": "string", "values": [ {}, {} ] } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "whitelist" } } } }, "delete": { "tags": [ "AccountManagementIPWhitelist" ], "operationId": "deleteAccountWhitelistId", "description": "The parameters and request body are for method: deleteAccountWhitelistId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/plantypes": { "get": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "getAccountPlantypes", "description": "The parameters and request body are for method: getAccountPlantypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "overage_order": { "type": "string" }, "type": { "type": "string" }, "balance": { "type": "string" }, "discount_type": { "type": "string" }, "monthly_price": { "type": "string" }, "access_charges": { "type": "object", "properties": { "static": { "type": "string" }, "intelligent": { "type": "string" }, "dynamic": { "type": "string" } } }, "period": { "type": "string" }, "discount": { "type": "string" }, "included": { "type": "object", "properties": { "any": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "static": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } } } }, "recurring_cost": { "type": "string" }, "overages": { "type": "object", "properties": { "static": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } } } }, "monitoring": { "type": "object", "properties": { "jobs": { "type": "number" }, "frequency": { "type": "number" }, "regions": { "type": "number" } } }, "locked": { "type": "boolean" } } } }, "example": [ { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 4, "records": 1 }, "static": { "queries": 2, "records": 10 }, "intelligent": { "queries": 10, "records": 3 }, "dynamic": { "queries": 3, "records": 2 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 2, "frequency": 10, "regions": 7 }, "locked": true }, { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 7, "records": 1 }, "static": { "queries": 6, "records": 2 }, "intelligent": { "queries": 4, "records": 3 }, "dynamic": { "queries": 9, "records": 6 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 7, "frequency": 2, "regions": 7 }, "locked": true }, { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 9, "records": 10 }, "static": { "queries": 1, "records": 9 }, "intelligent": { "queries": 5, "records": 5 }, "dynamic": { "queries": 8, "records": 10 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 8, "frequency": 1, "regions": 1 }, "locked": true }, { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 7, "records": 10 }, "static": { "queries": 8, "records": 2 }, "intelligent": { "queries": 7, "records": 3 }, "dynamic": { "queries": 5, "records": 6 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 8, "frequency": 9, "regions": 9 }, "locked": false } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/plan": { "get": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "getAccountPlan", "description": "The parameters and request body are for method: getAccountPlan. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "overage_order": { "type": "string" }, "type": { "type": "string" }, "balance": { "type": "string" }, "discount_type": { "type": "string" }, "monthly_price": { "type": "string" }, "access_charges": { "type": "object", "properties": { "static": { "type": "string" }, "intelligent": { "type": "string" }, "dynamic": { "type": "string" } } }, "period": { "type": "string" }, "discount": { "type": "string" }, "included": { "type": "object", "properties": { "any": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "static": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } } } }, "recurring_cost": { "type": "string" }, "overages": { "type": "object", "properties": { "static": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } } } }, "monitoring": { "type": "object", "properties": { "jobs": { "type": "number" }, "frequency": { "type": "number" }, "regions": { "type": "number" } } }, "locked": { "type": "boolean" } } }, "example": { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 8, "records": 1 }, "static": { "queries": 1, "records": 2 }, "intelligent": { "queries": 6, "records": 2 }, "dynamic": { "queries": 9, "records": 3 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 6, "frequency": 2, "regions": 1 }, "locked": true } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "postAccountPlan", "description": "The parameters and request body are for method: postAccountPlan. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "overage_order": { "type": "string" }, "type": { "type": "string" }, "balance": { "type": "string" }, "discount_type": { "type": "string" }, "monthly_price": { "type": "string" }, "access_charges": { "type": "object", "properties": { "static": { "type": "string" }, "intelligent": { "type": "string" }, "dynamic": { "type": "string" } } }, "period": { "type": "string" }, "discount": { "type": "string" }, "included": { "type": "object", "properties": { "any": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "static": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "number" }, "records": { "type": "number" } } } } }, "recurring_cost": { "type": "string" }, "overages": { "type": "object", "properties": { "static": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "intelligent": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } }, "dynamic": { "type": "object", "properties": { "queries": { "type": "string" }, "records": { "type": "string" } } } } }, "monitoring": { "type": "object", "properties": { "jobs": { "type": "number" }, "frequency": { "type": "number" }, "regions": { "type": "number" } } }, "locked": { "type": "boolean" } } }, "example": { "overage_order": "string", "type": "string", "balance": "string", "discount_type": "string", "monthly_price": "string", "access_charges": { "static": "string", "intelligent": "string", "dynamic": "string" }, "period": "string", "discount": "string", "included": { "any": { "queries": 7, "records": 10 }, "static": { "queries": 2, "records": 5 }, "intelligent": { "queries": 1, "records": 10 }, "dynamic": { "queries": 3, "records": 1 } }, "recurring_cost": "string", "overages": { "static": { "queries": "string", "records": "string" }, "intelligent": { "queries": "string", "records": "string" }, "dynamic": { "queries": "string", "records": "string" } }, "monitoring": { "jobs": 10, "frequency": 4, "regions": 7 }, "locked": false } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "string" } } }, "example": { "plan": "plan" } } } } } }, "/account/invoices": { "get": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "getAccountInvoices", "description": "The parameters and request body are for method: getAccountInvoices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "due": { "type": "number" }, "sent": { "type": "number" }, "id": { "type": "number" }, "amount": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "due": 2, "sent": 7, "id": 9, "amount": "string", "status": "string" }, { "due": 3, "sent": 3, "id": 6, "amount": "string", "status": "string" }, { "due": 2, "sent": 7, "id": 8, "amount": "string", "status": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/invoices/{invoiceid}": { "get": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "downloadAnInvoice", "description": "The parameters and request body are for method: downloadAnInvoice. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "invoiceid", "in": "path", "required": true, "schema": { "title": "invoiceid", "type": "string" } }, { "name": "authtoken", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/billataglance": { "get": { "tags": [ "AccountManagementPlanAndBilling" ], "operationId": "getAccountBillataglance", "description": "The parameters and request body are for method: getAccountBillataglance. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "string" }, "period": { "type": "string" }, "last_invoice": { "type": "number" }, "next_invoice": { "type": "number" }, "next_base_invoice": { "type": "number" }, "recurring_cost": { "type": "string" }, "recurring_cost_next_invoice": { "type": "string" }, "any": { "type": "object", "properties": { "overage_order": { "type": "string" }, "query_credit": { "type": "number" }, "record_credit": { "type": "number" } } }, "static": { "type": "object", "properties": { "record_rate": { "type": "string" }, "access_charge": { "type": "string" }, "records": { "type": "number" }, "query_credit": { "type": "number" }, "query_cost": { "type": "string" }, "query_rate_per_million": { "type": "string" }, "queries": { "type": "number" }, "record_credit": { "type": "number" }, "record_cost": { "type": "string" } } }, "dynamic": { "type": "object", "properties": { "record_rate": { "type": "string" }, "access_charge": { "type": "string" }, "records": { "type": "number" }, "query_credit": { "type": "number" }, "query_cost": { "type": "string" }, "query_rate_per_million": { "type": "string" }, "queries": { "type": "number" }, "record_credit": { "type": "number" }, "record_cost": { "type": "string" } } }, "intelligent": { "type": "object", "properties": { "record_rate": { "type": "string" }, "access_charge": { "type": "string" }, "records": { "type": "number" }, "query_credit": { "type": "number" }, "query_cost": { "type": "string" }, "query_rate_per_million": { "type": "string" }, "queries": { "type": "number" }, "record_credit": { "type": "number" }, "record_cost": { "type": "string" } } }, "totals": { "type": "object", "properties": { "record_cost": { "type": "string" }, "record_credit": { "type": "number" }, "queries": { "type": "number" }, "query_credit": { "type": "number" }, "records": { "type": "number" }, "access_charge": { "type": "string" }, "query_cost": { "type": "string" } } }, "balance": { "type": "string" }, "bill": { "type": "string" } } }, "example": { "plan": "string", "period": "string", "last_invoice": 9, "next_invoice": 5, "next_base_invoice": 8, "recurring_cost": "string", "recurring_cost_next_invoice": "string", "any": { "overage_order": "string", "query_credit": 5, "record_credit": 9 }, "static": { "record_rate": "string", "access_charge": "string", "records": 4, "query_credit": 9, "query_cost": "string", "query_rate_per_million": "string", "queries": 1, "record_credit": 10, "record_cost": "string" }, "dynamic": { "record_rate": "string", "access_charge": "string", "records": 5, "query_credit": 3, "query_cost": "string", "query_rate_per_million": "string", "queries": 3, "record_credit": 2, "record_cost": "string" }, "intelligent": { "record_rate": "string", "access_charge": "string", "records": 2, "query_credit": 8, "query_cost": "string", "query_rate_per_million": "string", "queries": 9, "record_credit": 10, "record_cost": "string" }, "totals": { "record_cost": "string", "record_credit": 6, "queries": 5, "query_credit": 3, "records": 8, "access_charge": "string", "query_cost": "string" }, "balance": "string", "bill": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/paymentmethods": { "get": { "tags": [ "AccountManagementPaymentMethod" ], "operationId": "getAccountPaymentmethods", "description": "The parameters and request body are for method: getAccountPaymentmethods. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "default": { "type": "boolean" }, "cc_expire_year": { "type": "number" }, "cc_expire_month": { "type": "number" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "company": { "type": "string" }, "cc_type": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalcode": { "type": "string" } } }, "cc_number_last4": { "type": "string" }, "id": { "type": "number" } } } }, "example": [ { "type": "string", "default": true, "cc_expire_year": 10, "cc_expire_month": 4, "firstname": "string", "lastname": "string", "company": "string", "cc_type": "string", "phone": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "cc_number_last4": "string", "id": 2 }, { "type": "string", "default": false, "cc_expire_year": 9, "cc_expire_month": 8, "firstname": "string", "lastname": "string", "company": "string", "cc_type": "string", "phone": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "cc_number_last4": "string", "id": 9 } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "AccountManagementPaymentMethod" ], "operationId": "addANewPaymentMethod", "description": "The parameters and request body are for method: addANewPaymentMethod. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "default": { "type": "boolean" }, "cc_expire_year": { "type": "number" }, "cc_expire_month": { "type": "number" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "company": { "type": "string" }, "cc_type": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalcode": { "type": "string" } } }, "cc_number_last4": { "type": "string" }, "id": { "type": "number" } } }, "example": { "type": "string", "default": true, "cc_expire_year": 1, "cc_expire_month": 6, "firstname": "string", "lastname": "string", "company": "string", "cc_type": "string", "phone": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "cc_number_last4": "string", "id": 9 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "paymentMethod" } } } } }, "/account/paymentmethods/{id}": { "get": { "tags": [ "AccountManagementPaymentMethod" ], "operationId": "getAccountPaymentmethodsId", "description": "The parameters and request body are for method: getAccountPaymentmethodsId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "default": { "type": "boolean" }, "cc_expire_year": { "type": "number" }, "cc_expire_month": { "type": "number" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "company": { "type": "string" }, "cc_type": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalcode": { "type": "string" } } }, "cc_number_last4": { "type": "string" }, "id": { "type": "number" } } }, "example": { "type": "string", "default": true, "cc_expire_year": 8, "cc_expire_month": 9, "firstname": "string", "lastname": "string", "company": "string", "cc_type": "string", "phone": "string", "address": { "country": "string", "street": "string", "state": "string", "city": "string", "postalcode": "string" }, "cc_number_last4": "string", "id": 1 } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AccountManagementPaymentMethod" ], "operationId": "makeAPaymentMethodTheDefault", "description": "The parameters and request body are for method: makeAPaymentMethodTheDefault. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "AccountManagementPaymentMethod" ], "operationId": "deleteAPaymentMethod", "description": "The parameters and request body are for method: deleteAPaymentMethod. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/account/activity": { "get": { "tags": [ "AccountManagementActivityLog" ], "operationId": "getAccountActivity", "description": "The parameters and request body are for method: getAccountActivity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "user_name": { "type": "string" }, "id": { "type": "string" }, "resource_type": { "type": "string" }, "user_id": { "type": "string" }, "resource_id": { "type": "string" }, "timestamp": { "type": "number" }, "user_type": { "type": "string" }, "action": { "type": "string" }, "resource": { "type": "object", "properties": { "id": { "type": "string" }, "hostmaster": { "type": "string" }, "meta": { "type": "object" }, "nx_ttl": { "type": "number" }, "retry": { "type": "number" }, "zone": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object" } }, "refresh": { "type": "number" }, "expiry": { "type": "number" }, "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "tier": { "type": "number" }, "short_answers": { "type": "array", "items": { "type": "string" } }, "domain": { "type": "string" } } } }, "dns_servers": { "type": "array", "items": { "type": "string" } }, "networks": { "type": "array", "items": { "type": "number" } }, "network_pools": { "type": "array", "items": { "type": "string" } } } } } } }, "example": [ { "user_name": "string", "id": "string", "resource_type": "string", "user_id": "string", "resource_id": "string", "timestamp": 8, "user_type": "string", "action": "string", "resource": { "id": "string", "hostmaster": "string", "meta": {}, "nx_ttl": 2, "retry": 6, "zone": "string", "warnings": [ {}, {}, {}, {}, {}, {} ], "refresh": 2, "expiry": 5, "records": [ { "id": "string", "type": "string", "tier": 6, "short_answers": [ "string", "string", "string", "string", "string", "string" ], "domain": "string" } ], "dns_servers": [ "string", "string", "string" ], "networks": [ 9, 5, 10, 1, 5 ], "network_pools": [ "string", "string", "string" ] } }, { "user_name": "string", "id": "string", "resource_type": "string", "user_id": "string", "resource_id": "string", "timestamp": 4, "user_type": "string", "action": "string", "resource": { "id": "string", "hostmaster": "string", "meta": {}, "nx_ttl": 1, "retry": 2, "zone": "string", "warnings": [ {}, {}, {} ], "refresh": 4, "expiry": 9, "records": [ { "id": "string", "type": "string", "tier": 1, "short_answers": [ "string", "string", "string", "string", "string", "string" ], "domain": "string" }, { "id": "string", "type": "string", "tier": 2, "short_answers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "domain": "string" } ], "dns_servers": [ "string", "string", "string", "string" ], "networks": [ 1, 8, 10, 2, 7, 2, 6, 2 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } }, { "user_name": "string", "id": "string", "resource_type": "string", "user_id": "string", "resource_id": "string", "timestamp": 5, "user_type": "string", "action": "string", "resource": { "id": "string", "hostmaster": "string", "meta": {}, "nx_ttl": 3, "retry": 3, "zone": "string", "warnings": [ {}, {}, {} ], "refresh": 4, "expiry": 2, "records": [ { "id": "string", "type": "string", "tier": 4, "short_answers": [ "string", "string", "string", "string", "string", "string" ], "domain": "string" }, { "id": "string", "type": "string", "tier": 2, "short_answers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "domain": "string" }, { "id": "string", "type": "string", "tier": 7, "short_answers": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "domain": "string" }, { "id": "string", "type": "string", "tier": 7, "short_answers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "domain": "string" } ], "dns_servers": [ "string", "string", "string", "string" ], "networks": [ 10, 10, 3 ], "network_pools": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } } ] } } } }, "parameters": [ { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resourceType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/qps": { "get": { "tags": [ "StatisticsQPS" ], "operationId": "getStatsQps", "description": "The parameters and request body are for method: getStatsQps. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "qps": { "type": "number" } } }, "example": { "qps": 9 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/qps/{zone}": { "get": { "tags": [ "StatisticsQPS" ], "operationId": "getStatsQpsZone", "description": "The parameters and request body are for method: getStatsQpsZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "qps": { "type": "number" } } }, "example": { "qps": 8 } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/qps/{zone}/{domain}/{type}": { "get": { "tags": [ "StatisticsQPS" ], "operationId": "getStatsQpsZoneDomainType", "description": "The parameters and request body are for method: getStatsQpsZoneDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "qps": { "type": "number" } } }, "example": { "qps": 8 } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/usage": { "get": { "tags": [ "StatisticsUsage" ], "operationId": "getStatsUsage", "description": "The parameters and request body are for method: getStatsUsage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "type": { "type": "string" }, "zone": { "type": "string" }, "expand": { "type": "boolean" }, "period": { "type": "string" }, "aggregate": { "type": "boolean" }, "by_tier": { "type": "boolean" } } }, "example": { "domain": "string", "type": "string", "zone": "string", "expand": true, "period": "1h", "aggregate": false, "by_tier": false } } } } }, "parameters": [ { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "aggregate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "byTier", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/usage/{zone}": { "get": { "tags": [ "StatisticsUsage" ], "operationId": "getStatsUsageZone", "description": "The parameters and request body are for method: getStatsUsageZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "type": { "type": "string" }, "zone": { "type": "string" }, "expand": { "type": "boolean" }, "period": { "type": "string" }, "aggregate": { "type": "boolean" }, "by_tier": { "type": "boolean" } } }, "example": { "domain": "string", "type": "string", "zone": "string", "expand": true, "period": "24h", "aggregate": true, "by_tier": false } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expand", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "aggregate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "byTier", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/stats/usage/{zone}/{domain}/{type}": { "get": { "tags": [ "StatisticsUsage" ], "operationId": "viewRecordLevelUsageStatistics", "description": "The parameters and request body are for method: viewRecordLevelUsageStatistics. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "type": { "type": "string" }, "zone": { "type": "string" }, "expand": { "type": "boolean" }, "period": { "type": "string" }, "aggregate": { "type": "boolean" }, "by_tier": { "type": "boolean" } } }, "example": { "domain": "string", "type": "string", "zone": "string", "expand": true, "period": "1h", "aggregate": false, "by_tier": false } } } } }, "parameters": [ { "name": "zone", "in": "path", "required": true, "schema": { "title": "zone", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps": { "get": { "tags": [ "PulsarApp" ], "operationId": "getPulsarApps", "description": "The parameters and request body are for method: getPulsarApps. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "example": [ {}, {}, {}, {} ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps/{appID}": { "get": { "tags": [ "PulsarApp" ], "operationId": "getPulsarAppsAppID", "description": "The parameters and request body are for method: getPulsarAppsAppID. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "appID", "in": "path", "required": true, "schema": { "title": "appID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps/{appID}/jobs": { "get": { "tags": [ "PulsarJob" ], "operationId": "getPulsarAppsAppIDJobs", "description": "The parameters and request body are for method: getPulsarAppsAppIDJobs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "example": [ {}, {} ] } } } }, "parameters": [ { "name": "appID", "in": "path", "required": true, "schema": { "title": "appID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps/{appID}/jobs/{jobID}": { "get": { "tags": [ "PulsarJob" ], "operationId": "getPulsarAppsAppIDJobsJobID", "description": "The parameters and request body are for method: getPulsarAppsAppIDJobsJobID. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "appID", "in": "path", "required": true, "schema": { "title": "appID", "type": "string" } }, { "name": "jobID", "in": "path", "required": true, "schema": { "title": "jobID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps/{appID}/jobs/{jobID}/data": { "get": { "tags": [ "PulsarPerformanceData" ], "operationId": "getPulsarAppsAppIDJobsJobIDData", "description": "The parameters and request body are for method: getPulsarAppsAppIDJobsJobIDData. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "appID", "in": "path", "required": true, "schema": { "title": "appID", "type": "string" } }, { "name": "jobID", "in": "path", "required": true, "schema": { "title": "jobID", "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "agg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "asn", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/apps/{appID}/jobs/{jobID}/availability": { "get": { "tags": [ "PulsarAvailability" ], "operationId": "getPulsarAppsAppIDJobsJobIDAvailability", "description": "The parameters and request body are for method: getPulsarAppsAppIDJobsJobIDAvailability. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "appID", "in": "path", "required": true, "schema": { "title": "appID", "type": "string" } }, { "name": "jobID", "in": "path", "required": true, "schema": { "title": "jobID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/query/decision/customer": { "get": { "tags": [ "PulsarDecisions" ], "operationId": "viewDecisionsForAccount", "description": "The parameters and request body are for method: viewDecisionsForAccount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "agg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "asn", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/query/decision/customer/undetermined": { "get": { "tags": [ "PulsarDecisions" ], "operationId": "viewInsufficientDecisionDataForAccount", "description": "The parameters and request body are for method: viewInsufficientDecisionDataForAccount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "agg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "asn", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/query/decision/record/{domain}/{type}": { "get": { "tags": [ "PulsarDecisions" ], "operationId": "getPulsarQueryDecisionRecordDomainType", "description": "The parameters and request body are for method: getPulsarQueryDecisionRecordDomainType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "agg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "asn", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/pulsar/query/decision/record/undetermined/{domain}/{rectype}": { "get": { "tags": [ "PulsarDecisions" ], "operationId": "getPulsarQueryDecisionRecordUndeterminedDomainRectype", "description": "The parameters and request body are for method: getPulsarQueryDecisionRecordUndeterminedDomainRectype. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "rectype", "in": "path", "required": true, "schema": { "title": "rectype", "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "geo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "agg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "asn", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }