{ "openapi": "3.1.0", "info": { "title": "Misaka API", "version": "3.0.1", "description": "" }, "paths": { "/v3/session/logout": { "post": { "operationId": "auth/session/logout", "summary": "Logout", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutResponse" } } } } }, "description": "Logout the current user", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } }, "required": true }, "security": [ { "Bearer": [] } ] } }, "/v3/session/token": { "get": { "operationId": "auth/session/token-get", "summary": "Get current user token", "parameters": [], "responses": { "200": { "description": "OK" } }, "description": "Get the current user token", "security": [ { "Bearer": [] } ] }, "post": { "operationId": "auth/session/token", "summary": "Get current user token", "parameters": [], "responses": { "200": { "description": "OK" } }, "description": "Get the current user token", "security": [ { "Bearer": [] } ] } }, "/v3/session/refresh": { "post": { "operationId": "auth/session/refresh", "summary": "Refresh user token", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshUserTokenResponse" } } } } }, "description": "Refresh the current user token", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshUserTokenRequest" } } }, "required": true } } }, "/v3/account/password": { "post": { "operationId": "auth/account/change-password", "summary": "Change password", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponse" } } } } }, "description": "Change the current user password", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "security": [ { "Bearer": [] } ] } }, "/v3/session/confirm-email": { "post": { "operationId": "auth/session/confirm-email", "summary": "Confirm email", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmEmailResponse" } } } } }, "description": "Confirm the current user email", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmEmailRequest" } } }, "required": true } } }, "/v3/team": { "get": { "operationId": "_auth/team/list", "summary": "List all Teams in God Mode", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Case-insensitive Team name search", "title": "Name" }, "required": false, "description": "Case-insensitive Team name search" }, { "in": "query", "name": "owner_id", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Team owner user ID", "title": "Owner Id" }, "required": false, "description": "Team owner user ID" }, { "in": "query", "name": "owner_email", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Case-insensitive Team owner email search", "title": "Owner Email" }, "required": false, "description": "Case-insensitive Team owner email search" }, { "in": "query", "name": "enable_sdwan", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter by whether SASE is enabled", "title": "Enable Sdwan" }, "required": false, "description": "Filter by whether SASE is enabled" }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated ordering fields: id, name, owner_id, owner_email, enable_sdwan", "title": "Ordering" }, "required": false, "description": "Comma-separated ordering fields: id, name, owner_id, owner_email, enable_sdwan" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTeamDirectorySchema" } } } } }, "description": "List every Team. This endpoint requires a staff user in God Mode.", "security": [ { "Bearer": [] } ] } }, "/v3/team/my": { "get": { "operationId": "auth/team/my", "summary": "Get current available teams", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Team Name", "title": "Name" }, "required": false, "description": "Team Name" }, { "in": "query", "name": "owner_id", "schema": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Team Owner ID", "title": "Owner Id" }, "required": false, "description": "Team Owner ID" }, { "in": "query", "name": "owner_email", "schema": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "string" }, { "type": "null" } ], "description": "Team Owner Email", "title": "Owner Email" }, "required": false, "description": "Team Owner Email" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTeamSchema" } } } } }, "description": "Get the current available teams", "security": [ { "Bearer": [] } ] } }, "/v3/team/{team_id}": { "get": { "operationId": "auth/team/{team_id}", "summary": "Get team", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDetailSchema" } } } } }, "description": "Get the team", "security": [ { "Bearer": [] } ] }, "patch": { "operationId": "auth/team/update", "summary": "Update Team", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDetailSchema" } } } } }, "description": "Update Team settings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] } ] } }, "/v3/team/{team_id}/members": { "get": { "operationId": "auth/team/members", "summary": "List team members", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true }, { "in": "query", "name": "user", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Case-insensitive Team member name or email search", "title": "User" }, "required": false, "description": "Case-insensitive Team member name or email search" }, { "in": "query", "name": "role", "schema": { "anyOf": [ { "items": { "enum": [ "owner", "admin", "member" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Filter by one or more Team roles", "title": "Role" }, "required": false, "description": "Filter by one or more Team roles" }, { "in": "query", "name": "email_verified", "schema": { "anyOf": [ { "items": { "type": "boolean" }, "type": "array" }, { "type": "null" } ], "description": "Filter by email verification state", "title": "Email Verified" }, "required": false, "description": "Filter by email verification state" }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated ordering fields: user, role, email_verified, created", "title": "Ordering" }, "required": false, "description": "Comma-separated ordering fields: user, role, email_verified, created" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTeamMemberObject" } } } } }, "description": "List the team members", "security": [ { "Bearer": [] } ] }, "post": { "operationId": "auth/team/members/add", "summary": "Add Team member", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberObject" } } } } }, "description": "Add an existing user to the Team by email address", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberCreateSchema" } } }, "required": true }, "security": [ { "Bearer": [] } ] } }, "/v3/team/{team_id}/members/{user_id}": { "patch": { "operationId": "auth/team/members/update", "summary": "Update Team member", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true }, { "in": "path", "name": "user_id", "schema": { "title": "User Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberObject" } } } } }, "description": "Promote or demote a Team member", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] } ] }, "delete": { "operationId": "auth/team/members/delete", "summary": "Remove Team member", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true }, { "in": "path", "name": "user_id", "schema": { "title": "User Id", "type": "integer" }, "required": true } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove a member from the Team", "security": [ { "Bearer": [] } ] } }, "/v3/team/{team_id}/domains": { "get": { "operationId": "auth/team/domains/list", "summary": "List Team domains", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TeamDomainObject" }, "title": "Response", "type": "array" } } } } }, "description": "List domains configured for the Team", "security": [ { "Bearer": [] } ] }, "post": { "operationId": "auth/team/domains/add", "summary": "Add Team domain", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDomainObject" } } } } }, "description": "Add a domain to the Team", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDomainCreateSchema" } } }, "required": true }, "security": [ { "Bearer": [] } ] } }, "/v3/team/{team_id}/domains/{domain_id}": { "delete": { "operationId": "auth/team/domains/delete", "summary": "Delete Team domain", "parameters": [ { "in": "path", "name": "team_id", "schema": { "title": "Team Id", "type": "string" }, "required": true }, { "in": "path", "name": "domain_id", "schema": { "title": "Domain Id", "type": "integer" }, "required": true } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a domain from the Team", "security": [ { "Bearer": [] } ] } }, "/v3/lighthouse/security/events/all": { "get": { "operationId": "lighthouse/security/events/list-all", "summary": "Event List All", "parameters": [ { "in": "query", "name": "flag", "schema": { "anyOf": [ { "enum": [ "INCOMING", "OUTGOING", "NETWORK_HOST", "NETWORK_SUBNET", "TYPE_DDOS_ATTACK", "TYPE_PORT_SCAN", "TYPE_BRUTE_FORCE", "TYPE_VULNERABILITY", "TYPE_MALWARE", "TYPE_PHISHING", "TYPE_BOTNET", "TYPE_C2", "TYPE_SPAM", "TYPE_DMCA", "TYPE_COPYRIGHT", "TYPE_LEGAL", "TYPE_PORN", "TYPE_ANOMALY", "TYPE_OTHER", "TYPE_RPKI_INVALID", "TYPE_ROUTE_LEAK", "TYPE_ROUTE_HIJACK", "TYPE_ROUTE_ANOMALY", "TYPE_UNSPECIFIED", "TYPE_RESERVED_1", "TYPE_RESERVED_2", "TYPE_RESERVED_3", "TYPE_RESERVED_4", "TYPE_RESERVED_5", "GROUP_SINGLE", "GROUP_MULTIPLE", "GROUP_UNSPECIFIED", "GROUP_NON_AGGREGATED", "GROUP_AGGREGATED", "GROUP_ALL", "SRC_INTERNAL", "SRC_EXTERNAL", "SRC_APERMON", "SRC_FASTNETMON", "SRC_AKVORADO", "SRC_RESERVED_1", "SRC_RESERVED_2", "SRC_RESERVED_3", "SRC_RESERVED_4", "SRC_RESERVED_5", "SRC_RESERVED_6", "SRC_RESERVED_7", "SRC_RESERVED_8", "SRC_RESERVED_9", "SRC_RESERVED_10", "SRC_RESERVED_11", "SRC_RESERVED_12", "SRC_RESERVED_13", "SRC_CDN77", "SRC_GSL", "SRC_GSL_CORERO", "SRC_RETN", "SRC_RBL", "SRC_CERT", "SRC_SHADOWSERVER", "SRC_BGPTOOLS", "SRC_M_WEBFORM", "SRC_M_EMAIL", "SRC_M_MANUAL", "SRC_CYBERTIPLINE", "SRC_INT_APERMON", "SRC_INT_FASTNETMON", "SRC_INT_AKVORADO", "SRC_INT_RESERVED_1", "SRC_INT_RESERVED_2", "SRC_INT_RESERVED_3", "SRC_INT_RESERVED_4", "SRC_INT_RESERVED_5", "SRC_INT_RESERVED_6", "SRC_INT_RESERVED_7", "SRC_INT_RESERVED_8", "SRC_INT_RESERVED_9", "SRC_INT_RESERVED_10", "SRC_INT_RESERVED_11", "SRC_INT_RESERVED_12", "SRC_INT_RESERVED_13", "SRC_EXT_CDN77", "SRC_EXT_GSL", "SRC_EXT_GSL_REPORT", "SRC_EXT_GSL_CORERO", "SRC_EXT_RETN", "SRC_EXT_RBL", "SRC_EXT_CERT", "SRC_EXT_SHADOWSERVER", "SRC_EXT_BGPTOOLS", "SRC_EXT_M_WEBFORM", "SRC_EXT_M_EMAIL", "SRC_EXT_M_MANUAL", "SRC_EXT_CYBERTIPLINE" ], "type": "string" }, { "type": "null" } ], "title": "Flag" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End" }, "required": false }, { "in": "query", "name": "affected_network", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Affected Network" }, "required": false }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "required": false }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "required": false }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSecurityEventFullSchema" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/security/events/related": { "get": { "operationId": "lighthouse/security/events/list-related", "summary": "Event List Related", "parameters": [ { "in": "query", "name": "flag", "schema": { "anyOf": [ { "enum": [ "INCOMING", "OUTGOING", "NETWORK_HOST", "NETWORK_SUBNET", "TYPE_DDOS_ATTACK", "TYPE_PORT_SCAN", "TYPE_BRUTE_FORCE", "TYPE_VULNERABILITY", "TYPE_MALWARE", "TYPE_PHISHING", "TYPE_BOTNET", "TYPE_C2", "TYPE_SPAM", "TYPE_DMCA", "TYPE_COPYRIGHT", "TYPE_LEGAL", "TYPE_PORN", "TYPE_ANOMALY", "TYPE_OTHER", "TYPE_RPKI_INVALID", "TYPE_ROUTE_LEAK", "TYPE_ROUTE_HIJACK", "TYPE_ROUTE_ANOMALY", "TYPE_UNSPECIFIED", "TYPE_RESERVED_1", "TYPE_RESERVED_2", "TYPE_RESERVED_3", "TYPE_RESERVED_4", "TYPE_RESERVED_5", "GROUP_SINGLE", "GROUP_MULTIPLE", "GROUP_UNSPECIFIED", "GROUP_NON_AGGREGATED", "GROUP_AGGREGATED", "GROUP_ALL", "SRC_INTERNAL", "SRC_EXTERNAL", "SRC_APERMON", "SRC_FASTNETMON", "SRC_AKVORADO", "SRC_RESERVED_1", "SRC_RESERVED_2", "SRC_RESERVED_3", "SRC_RESERVED_4", "SRC_RESERVED_5", "SRC_RESERVED_6", "SRC_RESERVED_7", "SRC_RESERVED_8", "SRC_RESERVED_9", "SRC_RESERVED_10", "SRC_RESERVED_11", "SRC_RESERVED_12", "SRC_RESERVED_13", "SRC_CDN77", "SRC_GSL", "SRC_GSL_CORERO", "SRC_RETN", "SRC_RBL", "SRC_CERT", "SRC_SHADOWSERVER", "SRC_BGPTOOLS", "SRC_M_WEBFORM", "SRC_M_EMAIL", "SRC_M_MANUAL", "SRC_CYBERTIPLINE", "SRC_INT_APERMON", "SRC_INT_FASTNETMON", "SRC_INT_AKVORADO", "SRC_INT_RESERVED_1", "SRC_INT_RESERVED_2", "SRC_INT_RESERVED_3", "SRC_INT_RESERVED_4", "SRC_INT_RESERVED_5", "SRC_INT_RESERVED_6", "SRC_INT_RESERVED_7", "SRC_INT_RESERVED_8", "SRC_INT_RESERVED_9", "SRC_INT_RESERVED_10", "SRC_INT_RESERVED_11", "SRC_INT_RESERVED_12", "SRC_INT_RESERVED_13", "SRC_EXT_CDN77", "SRC_EXT_GSL", "SRC_EXT_GSL_REPORT", "SRC_EXT_GSL_CORERO", "SRC_EXT_RETN", "SRC_EXT_RBL", "SRC_EXT_CERT", "SRC_EXT_SHADOWSERVER", "SRC_EXT_BGPTOOLS", "SRC_EXT_M_WEBFORM", "SRC_EXT_M_EMAIL", "SRC_EXT_M_MANUAL", "SRC_EXT_CYBERTIPLINE" ], "type": "string" }, { "type": "null" } ], "title": "Flag" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End" }, "required": false }, { "in": "query", "name": "affected_network", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Affected Network" }, "required": false }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "required": false }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "event__start,event__end,event__affected_bps,event__affected_pps", "title": "Ordering" }, "required": false }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSecurityEventFullSchema" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/security/events/related/{event_id}": { "get": { "operationId": "lighthouse/security/events/detail-related", "summary": "Event Detail Related", "parameters": [ { "in": "path", "name": "event_id", "schema": { "title": "Event Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityEventDetailSchema" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/security/events/related/{event_id}/attachments": { "get": { "operationId": "lighthouse/security/events/attachments", "summary": "Event Attachments", "parameters": [ { "in": "path", "name": "event_id", "schema": { "title": "Event Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SecurityEventAttachmentMetaSchema" }, "title": "Response", "type": "array" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/security/events/related.timeseries": { "get": { "operationId": "lighthouse/security/events/related-timeseries", "summary": "Event List Related Timeseries", "parameters": [ { "in": "query", "name": "flag", "schema": { "anyOf": [ { "enum": [ "INCOMING", "OUTGOING", "NETWORK_HOST", "NETWORK_SUBNET", "TYPE_DDOS_ATTACK", "TYPE_PORT_SCAN", "TYPE_BRUTE_FORCE", "TYPE_VULNERABILITY", "TYPE_MALWARE", "TYPE_PHISHING", "TYPE_BOTNET", "TYPE_C2", "TYPE_SPAM", "TYPE_DMCA", "TYPE_COPYRIGHT", "TYPE_LEGAL", "TYPE_PORN", "TYPE_ANOMALY", "TYPE_OTHER", "TYPE_RPKI_INVALID", "TYPE_ROUTE_LEAK", "TYPE_ROUTE_HIJACK", "TYPE_ROUTE_ANOMALY", "TYPE_UNSPECIFIED", "TYPE_RESERVED_1", "TYPE_RESERVED_2", "TYPE_RESERVED_3", "TYPE_RESERVED_4", "TYPE_RESERVED_5", "GROUP_SINGLE", "GROUP_MULTIPLE", "GROUP_UNSPECIFIED", "GROUP_NON_AGGREGATED", "GROUP_AGGREGATED", "GROUP_ALL", "SRC_INTERNAL", "SRC_EXTERNAL", "SRC_APERMON", "SRC_FASTNETMON", "SRC_AKVORADO", "SRC_RESERVED_1", "SRC_RESERVED_2", "SRC_RESERVED_3", "SRC_RESERVED_4", "SRC_RESERVED_5", "SRC_RESERVED_6", "SRC_RESERVED_7", "SRC_RESERVED_8", "SRC_RESERVED_9", "SRC_RESERVED_10", "SRC_RESERVED_11", "SRC_RESERVED_12", "SRC_RESERVED_13", "SRC_CDN77", "SRC_GSL", "SRC_GSL_CORERO", "SRC_RETN", "SRC_RBL", "SRC_CERT", "SRC_SHADOWSERVER", "SRC_BGPTOOLS", "SRC_M_WEBFORM", "SRC_M_EMAIL", "SRC_M_MANUAL", "SRC_CYBERTIPLINE", "SRC_INT_APERMON", "SRC_INT_FASTNETMON", "SRC_INT_AKVORADO", "SRC_INT_RESERVED_1", "SRC_INT_RESERVED_2", "SRC_INT_RESERVED_3", "SRC_INT_RESERVED_4", "SRC_INT_RESERVED_5", "SRC_INT_RESERVED_6", "SRC_INT_RESERVED_7", "SRC_INT_RESERVED_8", "SRC_INT_RESERVED_9", "SRC_INT_RESERVED_10", "SRC_INT_RESERVED_11", "SRC_INT_RESERVED_12", "SRC_INT_RESERVED_13", "SRC_EXT_CDN77", "SRC_EXT_GSL", "SRC_EXT_GSL_REPORT", "SRC_EXT_GSL_CORERO", "SRC_EXT_RETN", "SRC_EXT_RBL", "SRC_EXT_CERT", "SRC_EXT_SHADOWSERVER", "SRC_EXT_BGPTOOLS", "SRC_EXT_M_WEBFORM", "SRC_EXT_M_EMAIL", "SRC_EXT_M_MANUAL", "SRC_EXT_CYBERTIPLINE" ], "type": "string" }, { "type": "null" } ], "title": "Flag" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End" }, "required": false }, { "in": "query", "name": "affected_network", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Affected Network" }, "required": false }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "required": false }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedEventTimeseriesSchema" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/network/flow/timeseries": { "post": { "operationId": "lighthouse/network/flow/timeseries", "summary": "Network Flow Timeseries", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkMetricSchema" } } } } }, "tags": [ "lighthouse" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkFlowTimeseriesRequestSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/utils/timezone": { "get": { "operationId": "lighthouse/utils/timezone", "summary": "Timezone For Location", "parameters": [ { "in": "query", "name": "country", "schema": { "title": "Country", "type": "string" }, "required": true }, { "in": "query", "name": "location", "schema": { "title": "Location", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationTimezoneSchema" } } } } }, "tags": [ "lighthouse" ] } }, "/v3/lighthouse/security/shield/rules": { "get": { "operationId": "lighthouse/shield/rules/list", "summary": "Shield Rules List", "parameters": [ { "in": "query", "name": "prefix", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix" }, "required": false }, { "in": "query", "name": "asn", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Asn" }, "required": false }, { "in": "query", "name": "force_inline", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Force Inline" }, "required": false }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "required": false }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedDDoSPrefixPolicySchema" } } } } }, "tags": [ "lighthouse" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/lighthouse/security/shield/rules/{policy_id}": { "put": { "operationId": "lighthouse/shield/rules/update", "summary": "Shield Rules Update", "parameters": [ { "in": "path", "name": "policy_id", "schema": { "title": "Policy Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DDoSPrefixPolicySchema" } } } } }, "tags": [ "lighthouse" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DDoSPrefixPolicyUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/xconnects": { "get": { "operationId": "infra/xconnects/list", "summary": "List cross connects", "parameters": [ { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the circuit", "title": "Description" }, "required": false, "description": "Description of the circuit" }, { "in": "query", "name": "status", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Status of the circuit", "title": "Status" }, "required": false, "description": "Status of the circuit" }, { "in": "query", "name": "tags", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags of the circuit", "title": "Tags" }, "required": false, "description": "Tags of the circuit" }, { "in": "query", "name": "facility", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Facility of the circuit", "title": "Facility" }, "required": false, "description": "Facility of the circuit" }, { "in": "query", "name": "side_a", "schema": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Side A of the circuit", "title": "Side A" }, "required": false, "description": "Side A of the circuit" }, { "in": "query", "name": "side_z", "schema": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Side Z of the circuit", "title": "Side Z" }, "required": false, "description": "Side Z of the circuit" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedCrossConnectSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices/group-by": { "get": { "operationId": "infra/devices/group-by", "summary": "Group devices for filtering", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the device", "title": "Name" }, "required": false, "description": "Name of the device" }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the device", "title": "Description" }, "required": false, "description": "Description of the device" }, { "in": "query", "name": "rack", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Rack names", "title": "Rack" }, "required": false, "description": "Rack names" }, { "in": "query", "name": "manufacturer", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Manufacturer slugs", "title": "Manufacturer" }, "required": false, "description": "Manufacturer slugs" }, { "in": "query", "name": "model", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Device model names", "title": "Model" }, "required": false, "description": "Device model names" }, { "in": "query", "name": "position", "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Position in the rack", "title": "Position" }, "required": false, "description": "Position in the rack" }, { "in": "query", "name": "group_by", "schema": { "enum": [ "rack", "manufacturer", "model" ], "title": "Group By", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroupBySchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices": { "get": { "operationId": "infra/devices/list", "summary": "List devices", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the device", "title": "Name" }, "required": false, "description": "Name of the device" }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the device", "title": "Description" }, "required": false, "description": "Description of the device" }, { "in": "query", "name": "rack", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Rack names", "title": "Rack" }, "required": false, "description": "Rack names" }, { "in": "query", "name": "manufacturer", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Manufacturer slugs", "title": "Manufacturer" }, "required": false, "description": "Manufacturer slugs" }, { "in": "query", "name": "model", "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Device model names", "title": "Model" }, "required": false, "description": "Device model names" }, { "in": "query", "name": "position", "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Position in the rack", "title": "Position" }, "required": false, "description": "Position in the rack" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedDeviceSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices/{device_id}": { "get": { "operationId": "infra/devices/detail", "summary": "Get device details", "parameters": [ { "in": "path", "name": "device_id", "schema": { "title": "Device Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices/{device_id}/interfaces": { "get": { "operationId": "infra/devices/interfaces/list", "summary": "List interfaces for a device", "parameters": [ { "in": "path", "name": "device_id", "schema": { "title": "Device Id", "type": "integer" }, "required": true }, { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the port", "title": "Name" }, "required": false, "description": "Name of the port" }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the port", "title": "Description" }, "required": false, "description": "Description of the port" }, { "in": "query", "name": "enabled", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the port is enabled", "title": "Enabled" }, "required": false, "description": "Whether the port is enabled" }, { "in": "query", "name": "speed", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Speed of the port in Mbps", "title": "Speed" }, "required": false, "description": "Speed of the port in Mbps" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedPortSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices/{device_id}/attachments": { "get": { "operationId": "infra/devices/attachments/list", "summary": "List attachments for a device", "parameters": [ { "in": "path", "name": "device_id", "schema": { "title": "Device Id", "type": "integer" }, "required": true }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedDeviceAttachmentSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/devices/{device_id}/metrics": { "get": { "operationId": "infra/devices/metrics", "summary": "Device metrics", "parameters": [ { "in": "path", "name": "device_id", "schema": { "title": "Device Id", "type": "integer" }, "required": true }, { "in": "query", "name": "time_range", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Range" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMetricsSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/ports": { "get": { "operationId": "infra/ports/list", "summary": "List ports", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the port", "title": "Name" }, "required": false, "description": "Name of the port" }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the port", "title": "Description" }, "required": false, "description": "Description of the port" }, { "in": "query", "name": "enabled", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the port is enabled", "title": "Enabled" }, "required": false, "description": "Whether the port is enabled" }, { "in": "query", "name": "speed", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Speed of the port in Mbps", "title": "Speed" }, "required": false, "description": "Speed of the port in Mbps" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedPortSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/ports/{port_id}": { "get": { "operationId": "infra/ports/info", "summary": "Port info", "parameters": [ { "in": "path", "name": "port_id", "schema": { "title": "Port Id", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortInfoSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/ports/{port_id}/metrics/transceiver": { "get": { "operationId": "infra/ports/transceiver-metrics", "summary": "Port transceiver metrics", "parameters": [ { "in": "path", "name": "port_id", "schema": { "title": "Port Id", "type": "string" }, "required": true }, { "in": "query", "name": "time_range", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Range" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransceiverMetricsSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/ports/{port_id}/metrics/usage": { "get": { "operationId": "infra/ports/usage-metrics", "summary": "Port usage metrics", "parameters": [ { "in": "path", "name": "port_id", "schema": { "title": "Port Id", "type": "string" }, "required": true }, { "in": "query", "name": "time_range", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Range" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortUsageMetricsSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/services": { "get": { "operationId": "infra/services/list", "summary": "List services", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the service (case-insensitive search)", "title": "Name" }, "required": false, "description": "Name of the service (case-insensitive search)" }, { "in": "query", "name": "description", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the service (case-insensitive search)", "title": "Description" }, "required": false, "description": "Description of the service (case-insensitive search)" }, { "in": "query", "name": "service_type", "schema": { "anyOf": [ { "enum": [ "RECURRING", "ONE_TIME", "FINE", "IAAS", "NET", "COLOCATION", "CROSS_CONNECT", "POWER", "RACK", "REMOTE_HAND", "IAAS_RESERVED_5", "IAAS_RESERVED_6", "IAAS_RESERVED_7", "IAAS_RESERVED_8", "IAAS_RESERVED_9", "IP_TRANSIT", "IX_RESELLER", "L2", "NET_RESERVED_3", "NET_RESERVED_4", "NET_RESERVED_5", "NET_RESERVED_6", "NET_RESERVED_7", "NET_RESERVED_8", "NET_RESERVED_9", "IAAS_COLOCATION", "IAAS_CROSS_CONNECT", "IAAS_POWER", "IAAS_RACK", "IAAS_REMOTE_HAND", "IAAS_MISC_ONE_TIME", "IAAS_MISC_FINE", "NET_IP_TRANSIT", "NET_IX_RESELLER", "NET_L2" ], "type": "string" }, { "type": "null" } ], "description": "Service type", "title": "Service Type" }, "required": false, "description": "Service type" }, { "in": "query", "name": "billing_type", "schema": { "anyOf": [ { "enum": [ "RECURRING", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "ANNUAL", "ONE_TIME", "RECURRING_MONTHLY", "RECURRING_QUARTERLY", "RECURRING_SEMIANNUAL", "RECURRING_ANNUAL" ], "type": "string" }, { "type": "null" } ], "description": "Billing type", "title": "Billing Type" }, "required": false, "description": "Billing type" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedServiceSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/infra/service/{service_id}/billable_ports": { "get": { "operationId": "infra/service/billable-ports/list", "summary": "List service billable ports", "parameters": [ { "in": "path", "name": "service_id", "schema": { "title": "Service Id", "type": "integer" }, "required": true }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedServiceBillablePortSchema" } } } } }, "tags": [ "infra" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "post": { "operationId": "_infra/service/billable-ports/upsert-post", "summary": "Create or update service billable port", "parameters": [ { "in": "path", "name": "service_id", "schema": { "title": "Service Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBillablePortSchema" } } } } }, "tags": [ "infra" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBillablePortWriteSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "put": { "operationId": "_infra/service/billable-ports/upsert-put", "summary": "Create or update service billable port", "parameters": [ { "in": "path", "name": "service_id", "schema": { "title": "Service Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBillablePortSchema" } } } } }, "tags": [ "infra" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBillablePortWriteSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/ipam/asn/{asn}/verify-ownership": { "get": { "operationId": "ipam/asn/verify-ownership", "summary": "Verify ASN ownership", "parameters": [ { "in": "path", "name": "asn", "schema": { "title": "Asn", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ASNOwnershipVerificationResultSchema" } } } } }, "tags": [ "ipam" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/ipam/announcements/{announcement_id}": { "patch": { "operationId": "ipam/byoip/update-announcement", "summary": "Update IP announcement", "parameters": [ { "in": "path", "name": "announcement_id", "schema": { "title": "Announcement Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BYOIPAnnouncement" } } } } }, "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BYOIPAnnouncementChangeRequestSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "delete": { "operationId": "ipam/byoip/delete-announcement", "summary": "Delete IP announcement", "parameters": [ { "in": "path", "name": "announcement_id", "schema": { "title": "Announcement Id", "type": "integer" }, "required": true } ], "responses": { "200": { "description": "OK" } }, "tags": [ "ipam" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/ipam/announcements": { "get": { "operationId": "ipam/byoip/list-announcements", "summary": "Get IP announcements", "parameters": [ { "in": "query", "name": "user", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "User ID", "title": "User" }, "required": false, "description": "User ID" }, { "in": "query", "name": "region", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Region", "title": "Region" }, "required": false, "description": "Region" }, { "in": "query", "name": "enabled", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enabled", "title": "Enabled" }, "required": false, "description": "Enabled" }, { "in": "query", "name": "prefix", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Prefix", "title": "Prefix" }, "required": false, "description": "Prefix" }, { "in": "query", "name": "prefixlen", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Prefix length", "title": "Prefixlen" }, "required": false, "description": "Prefix length" }, { "in": "query", "name": "origin_asn", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Origin ASN", "title": "Origin Asn" }, "required": false, "description": "Origin ASN" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBYOIPAnnouncement" } } } } }, "tags": [ "ipam" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "post": { "operationId": "ipam/byoip/create-announcements", "summary": "Create IP announcements", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BYOIPAnnouncement" }, "title": "Response", "type": "array" } } } } }, "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BYOIPAnnouncementRequestSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/ipam/loa/upload": { "post": { "operationId": "ipam/byoip/upload-loa", "summary": "Upload LOA file for BYOIP", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BYOIPLOASchema" }, "title": "Response", "type": "array" } } } } }, "tags": [ "ipam" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "files": { "items": { "format": "binary", "type": "string" }, "title": "Files", "type": "array" } }, "required": [ "files" ], "title": "FileParams", "type": "object" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/mc2/metrics/instance": { "get": { "operationId": "mc2/metrics/instance", "summary": "Get instance metrics", "parameters": [ { "in": "query", "name": "id", "schema": { "title": "Id", "type": "integer" }, "required": true }, { "in": "query", "name": "since", "schema": { "default": "-24h", "enum": [ "-1h", "-6h", "-24h", "-48h", "-1w", "-1m", "-1y" ], "title": "Since", "type": "string" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response", "type": "object" } } } } }, "tags": [ "mc2", "metrics" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/mc2/metrics/hypervisor": { "get": { "operationId": "mc2/metrics/hypervisor", "summary": "Get hypervisor metrics", "parameters": [ { "in": "query", "name": "id", "schema": { "title": "Id", "type": "integer" }, "required": true }, { "in": "query", "name": "since", "schema": { "default": "-24h", "enum": [ "-1h", "-6h", "-24h", "-48h", "-1w", "-1m", "-1y" ], "title": "Since", "type": "string" }, "required": false }, { "in": "query", "name": "start", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "required": false }, { "in": "query", "name": "end", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorMetricsSchema" } } } } }, "tags": [ "mc2", "metrics" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/mc2/metrics/hypervisors": { "get": { "operationId": "mc2/metrics/hypervisors", "summary": "Get live hypervisor metrics", "parameters": [ { "in": "query", "name": "ids", "schema": { "items": { "type": "integer" }, "title": "Ids", "type": "array" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/HypervisorLiveMetricSchema" }, "title": "Response", "type": "array" } } } } }, "tags": [ "mc2", "metrics" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/mc2/metrics/account-throughput": { "get": { "operationId": "mc2/metrics/account-throughput", "summary": "Get throughput aggregated by account and region", "parameters": [ { "in": "query", "name": "period", "schema": { "default": "24h", "enum": [ "24h", "month" ], "title": "Period", "type": "string" }, "required": false }, { "in": "query", "name": "search", "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Search" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountThroughputResponseSchema" } } } } }, "tags": [ "mc2", "metrics" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/mc2/metrics/interface-traffic": { "get": { "operationId": "mc2/metrics/interface-traffic", "summary": "Get interface traffic metrics", "parameters": [ { "in": "query", "name": "select", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Select" }, "required": false }, { "in": "query", "name": "materialized", "schema": { "default": "hourly", "enum": [ "hourly", "daily", "monthly" ], "title": "Materialized", "type": "string" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response", "type": "object" } } } } }, "tags": [ "mc2", "metrics" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones": { "get": { "operationId": "dns/zones/list", "summary": "List Zones", "parameters": [ { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Zone name", "q": "name__icontains", "title": "Name" }, "required": false, "description": "Zone name" }, { "in": "query", "name": "ordering", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "required": false }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedFullZoneSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "post": { "operationId": "dns/zones/create", "summary": "Create Zone", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullZoneSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneCreateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}/settings": { "get": { "operationId": "dns/zones/settings/get", "summary": "Get Zone Settings", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneSettingsSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "put": { "operationId": "dns/zones/settings/update", "summary": "Update Zone Settings", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneSettingsSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}": { "delete": { "operationId": "dns/zones/delete", "summary": "Delete Zone", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}/import": { "post": { "operationId": "dns/zones/import", "summary": "Import Zone", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneImportResponseSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneImportSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}/dnssec": { "get": { "operationId": "dns/zones/dnssec/get", "summary": "Get DNSSEC Configuration", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "post": { "operationId": "dns/zones/dnssec/enable", "summary": "Enable DNSSEC", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "delete": { "operationId": "dns/zones/dnssec/disable", "summary": "Disable DNSSEC", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true } ], "responses": { "204": { "description": "No Content" } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}/recordsets": { "get": { "operationId": "dns/zones/recordsets/list", "summary": "List Recordsets", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true }, { "in": "query", "name": "name", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Record name", "q": "name__icontains", "title": "Name" }, "required": false, "description": "Record name" }, { "in": "query", "name": "records", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Records", "q": "records__icontains", "title": "Records" }, "required": false, "description": "Records" }, { "in": "query", "name": "limit", "schema": { "default": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "required": false }, { "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedRecordSetSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/zones/{domain}/recordsets/{name}/{type}": { "post": { "operationId": "dns/recordsets/create", "summary": "Create RecordSet", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true }, { "in": "path", "name": "name", "schema": { "title": "Name", "type": "string" }, "required": true }, { "in": "path", "name": "type", "schema": { "title": "Type", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetCreateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "get": { "operationId": "dns/recordsets/get", "summary": "Get RecordSet", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true }, { "in": "path", "name": "name", "schema": { "title": "Name", "type": "string" }, "required": true }, { "in": "path", "name": "type", "schema": { "title": "Type", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetSchema" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "put": { "operationId": "dns/recordsets/update", "summary": "Update RecordSet", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true }, { "in": "path", "name": "name", "schema": { "title": "Name", "type": "string" }, "required": true }, { "in": "path", "name": "type", "schema": { "title": "Type", "type": "string" }, "required": true }, { "in": "query", "name": "append", "schema": { "default": false, "title": "Append", "type": "boolean" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordSetUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] }, "delete": { "operationId": "dns/recordsets/delete", "summary": "Delete RecordSet", "parameters": [ { "in": "path", "name": "domain", "schema": { "title": "Domain", "type": "string" }, "required": true }, { "in": "path", "name": "name", "schema": { "title": "Name", "type": "string" }, "required": true }, { "in": "path", "name": "type", "schema": { "title": "Type", "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response", "type": "object" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/filters/{filter_name}": { "get": { "operationId": "dns/filters/list", "summary": "Get Filter Keys", "parameters": [ { "in": "path", "name": "filter_name", "schema": { "title": "Filter Name", "type": "string" }, "required": true }, { "in": "query", "name": "q", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" }, "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FilterKeySchema" }, "title": "Response", "type": "array" } } } } }, "tags": [ "dns" ], "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } }, "/v3/dns/ptrs/batch": { "post": { "operationId": "dns/ptrs/batch", "summary": "Batch Update PTR Records", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PTRUpdateResponseSchema" } } } } }, "tags": [ "dns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PTRUpdateSchema" } } }, "required": true }, "security": [ { "Bearer": [] }, { "AuthLegacyJWTBearer": [] }, { "AuthLegacyBearerToken": [] }, { "APIToken": [] } ] } } }, "components": { "schemas": { "LogoutResponse": { "properties": { "detail": { "title": "Detail", "type": "string" } }, "required": [ "detail" ], "title": "LogoutResponse", "type": "object" }, "LogoutRequest": { "properties": { "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" }, "sliding_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sliding Token" } }, "title": "LogoutRequest", "type": "object" }, "TeamObject": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Team ID", "title": "Id" }, "name": { "description": "Team Name", "title": "Name", "type": "string" }, "is_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the user is an admin of the team", "title": "Is Admin" }, "enable_sdwan": { "description": "Whether SASE is enabled", "title": "Enable Sdwan", "type": "boolean" }, "enable_dns": { "description": "Whether DNS is enabled", "title": "Enable Dns", "type": "boolean" } }, "required": [ "id", "name", "enable_sdwan", "enable_dns" ], "title": "TeamObject", "type": "object" }, "CurrentUserObject": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "User ID", "title": "Id" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "Email address", "title": "Email" }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Avatar URL if available, otherwise it will be the Gravatar URL", "title": "Avatar Url" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username, only set for legacy users and will be deprecated in the future", "title": "Username" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First Name", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last Name", "title": "Last Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display Name", "title": "Display Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "ZZ", "description": "Country code, default to ZZ for legacy users", "title": "Country" }, "is_staff": { "description": "Whether the user is a staff member", "title": "Is Staff", "type": "boolean" }, "whmcs_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "WHMCS UUID, only set for legacy users and will be deprecated in the future", "title": "Whmcs Uuid" }, "current_team": { "anyOf": [ { "$ref": "#/components/schemas/TeamObject" }, { "type": "null" } ], "description": "Current team the user is in" }, "teams": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TeamObject" }, "type": "array" }, { "type": "null" } ], "description": "List of teams the user has access to", "title": "Teams" }, "enabled_modules": { "description": "List of navigation items", "items": { "type": "string" }, "title": "Enabled Modules", "type": "array" } }, "required": [ "id", "is_staff", "enabled_modules" ], "title": "CurrentUserObject", "type": "object" }, "RefreshUserTokenResponse": { "properties": { "access": { "description": "The access token", "title": "Access", "type": "string" }, "refresh": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The refresh token, only returned if the current token is being rotated", "title": "Refresh" }, "user_etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The etag of the user object", "title": "User Etag" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/CurrentUserObject" }, { "type": "null" } ], "description": "The user object" } }, "required": [ "access" ], "title": "RefreshUserTokenResponse", "type": "object" }, "RefreshUserTokenRequest": { "properties": { "refresh": { "description": "The refresh token", "title": "Refresh", "type": "string" }, "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The etag of the user object", "title": "Etag" } }, "required": [ "refresh" ], "title": "RefreshUserTokenRequest", "type": "object" }, "ChangePasswordResponse": { "properties": { "success": { "title": "Success", "type": "boolean" } }, "required": [ "success" ], "title": "ChangePasswordResponse", "type": "object" }, "ChangePasswordRequest": { "properties": { "current_password": { "description": "The current password", "minLength": 6, "title": "Current Password", "type": "string" }, "new_password": { "description": "The new password", "minLength": 6, "title": "New Password", "type": "string" }, "logout_all_sessions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "If true, all sessions will be logged out", "title": "Logout All Sessions" } }, "required": [ "current_password", "new_password" ], "title": "ChangePasswordRequest", "type": "object" }, "ConfirmEmailResponse": { "properties": { "success": { "title": "Success", "type": "boolean" } }, "required": [ "success" ], "title": "ConfirmEmailResponse", "type": "object" }, "ConfirmEmailRequest": { "properties": { "email": { "description": "The email address", "format": "email", "title": "Email", "type": "string" }, "code": { "description": "The confirmation code", "title": "Code", "type": "string" }, "nonce": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nonce" } }, "required": [ "email", "code", "nonce" ], "title": "ConfirmEmailRequest", "type": "object" }, "PagedTeamDirectorySchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/TeamDirectorySchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedTeamDirectorySchema", "type": "object" }, "TeamDirectorySchema": { "description": "One Team per row for the staff-only God Mode directory.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Team ID", "title": "Id" }, "name": { "description": "Team Name", "title": "Name", "type": "string" }, "enable_sdwan": { "description": "Whether SASE is enabled", "title": "Enable Sdwan", "type": "boolean" }, "owner_id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Team Owner ID", "title": "Owner Id" }, "owner_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "Team Owner Email", "title": "Owner Email" }, "is_admin": { "description": "Whether the current God Mode user can administer the Team", "title": "Is Admin", "type": "boolean" } }, "required": [ "id", "name", "enable_sdwan", "is_admin" ], "title": "TeamDirectorySchema", "type": "object" }, "PagedTeamSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/TeamSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedTeamSchema", "type": "object" }, "TeamSchema": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Team ID", "title": "Id" }, "name": { "description": "Team Name", "title": "Name", "type": "string" }, "enable_sdwan": { "description": "Whether SASE is enabled", "title": "Enable Sdwan", "type": "boolean" }, "enable_dns": { "description": "Whether DNS is enabled", "title": "Enable Dns", "type": "boolean" }, "owner_id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Team Owner ID", "title": "Owner Id" }, "owner_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "Team Owner Email", "title": "Owner Email" }, "is_admin": { "description": "Whether the user is an admin of the team", "title": "Is Admin", "type": "boolean" } }, "required": [ "id", "name", "enable_sdwan", "enable_dns", "is_admin" ], "title": "TeamSchema", "type": "object" }, "TeamDetailSchema": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "description": "Team ID", "title": "Id" }, "name": { "description": "Team Name", "title": "Name", "type": "string" }, "enable_sdwan": { "description": "Whether SASE is enabled", "title": "Enable Sdwan", "type": "boolean" }, "enable_dns": { "description": "Whether DNS is enabled", "title": "Enable Dns", "type": "boolean" }, "owner_id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Team Owner ID", "title": "Owner Id" }, "owner_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "Team Owner Email", "title": "Owner Email" }, "is_admin": { "description": "Whether the user is an admin of the team", "title": "Is Admin", "type": "boolean" }, "enable_netbox": { "description": "Whether NetBox is enabled", "title": "Enable Netbox", "type": "boolean" }, "managed": { "description": "Whether the Team is managed", "title": "Managed", "type": "boolean" }, "is_legacy": { "description": "Whether this is a legacy Team", "title": "Is Legacy", "type": "boolean" }, "member_count": { "description": "Number of Team members", "title": "Member Count", "type": "integer" }, "domain_count": { "description": "Number of configured Team domains", "title": "Domain Count", "type": "integer" } }, "required": [ "id", "name", "enable_sdwan", "enable_dns", "is_admin", "enable_netbox", "managed", "is_legacy", "member_count", "domain_count" ], "title": "TeamDetailSchema", "type": "object" }, "TeamUpdateSchema": { "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "TeamUpdateSchema", "type": "object" }, "PagedTeamMemberObject": { "properties": { "results": { "items": { "$ref": "#/components/schemas/TeamMemberObject" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedTeamMemberObject", "type": "object" }, "TeamMemberObject": { "properties": { "id": { "description": "Team Member ID", "title": "Id", "type": "integer" }, "email": { "description": "Team Member Email", "title": "Email", "type": "string" }, "first_name": { "description": "Team Member First Name", "title": "First Name", "type": "string" }, "last_name": { "description": "Team Member Last Name", "title": "Last Name", "type": "string" }, "is_admin": { "description": "Whether the user is an admin of the team", "title": "Is Admin", "type": "boolean" }, "is_owner": { "description": "Whether the user owns the Team", "title": "Is Owner", "type": "boolean" }, "email_verified": { "description": "Whether the user's email is verified", "title": "Email Verified", "type": "boolean" }, "created": { "description": "Team Member Created At", "format": "date-time", "title": "Created", "type": "string" }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Avatar URL if available, otherwise it will be the Gravatar URL", "title": "Avatar Url" } }, "required": [ "id", "email", "first_name", "last_name", "is_admin", "is_owner", "email_verified", "created" ], "title": "TeamMemberObject", "type": "object" }, "TeamMemberCreateSchema": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "is_admin": { "default": false, "title": "Is Admin", "type": "boolean" } }, "required": [ "email" ], "title": "TeamMemberCreateSchema", "type": "object" }, "TeamMemberUpdateSchema": { "properties": { "is_admin": { "title": "Is Admin", "type": "boolean" } }, "required": [ "is_admin" ], "title": "TeamMemberUpdateSchema", "type": "object" }, "TeamDomainObject": { "properties": { "id": { "title": "Id", "type": "integer" }, "domain": { "title": "Domain", "type": "string" }, "verified": { "title": "Verified", "type": "boolean" }, "verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Verified At" }, "verified_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verified By" } }, "required": [ "id", "domain", "verified" ], "title": "TeamDomainObject", "type": "object" }, "TeamDomainCreateSchema": { "properties": { "domain": { "maxLength": 255, "minLength": 1, "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "TeamDomainCreateSchema", "type": "object" }, "PagedSecurityEventFullSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SecurityEventFullSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedSecurityEventFullSchema", "type": "object" }, "SecurityEventFullSchema": { "properties": { "id": { "title": "Id", "type": "string" }, "flags": { "items": { "enum": [ "INCOMING", "OUTGOING", "NETWORK_HOST", "NETWORK_SUBNET", "TYPE_DDOS_ATTACK", "TYPE_PORT_SCAN", "TYPE_BRUTE_FORCE", "TYPE_VULNERABILITY", "TYPE_MALWARE", "TYPE_PHISHING", "TYPE_BOTNET", "TYPE_C2", "TYPE_SPAM", "TYPE_DMCA", "TYPE_COPYRIGHT", "TYPE_LEGAL", "TYPE_PORN", "TYPE_ANOMALY", "TYPE_OTHER", "TYPE_RPKI_INVALID", "TYPE_ROUTE_LEAK", "TYPE_ROUTE_HIJACK", "TYPE_ROUTE_ANOMALY", "TYPE_UNSPECIFIED", "TYPE_RESERVED_1", "TYPE_RESERVED_2", "TYPE_RESERVED_3", "TYPE_RESERVED_4", "TYPE_RESERVED_5", "GROUP_SINGLE", "GROUP_MULTIPLE", "GROUP_UNSPECIFIED", "GROUP_NON_AGGREGATED", "GROUP_AGGREGATED", "GROUP_ALL", "SRC_INTERNAL", "SRC_EXTERNAL", "SRC_APERMON", "SRC_FASTNETMON", "SRC_AKVORADO", "SRC_RESERVED_1", "SRC_RESERVED_2", "SRC_RESERVED_3", "SRC_RESERVED_4", "SRC_RESERVED_5", "SRC_RESERVED_6", "SRC_RESERVED_7", "SRC_RESERVED_8", "SRC_RESERVED_9", "SRC_RESERVED_10", "SRC_RESERVED_11", "SRC_RESERVED_12", "SRC_RESERVED_13", "SRC_CDN77", "SRC_GSL", "SRC_GSL_CORERO", "SRC_RETN", "SRC_RBL", "SRC_CERT", "SRC_SHADOWSERVER", "SRC_BGPTOOLS", "SRC_M_WEBFORM", "SRC_M_EMAIL", "SRC_M_MANUAL", "SRC_CYBERTIPLINE", "SRC_INT_APERMON", "SRC_INT_FASTNETMON", "SRC_INT_AKVORADO", "SRC_INT_RESERVED_1", "SRC_INT_RESERVED_2", "SRC_INT_RESERVED_3", "SRC_INT_RESERVED_4", "SRC_INT_RESERVED_5", "SRC_INT_RESERVED_6", "SRC_INT_RESERVED_7", "SRC_INT_RESERVED_8", "SRC_INT_RESERVED_9", "SRC_INT_RESERVED_10", "SRC_INT_RESERVED_11", "SRC_INT_RESERVED_12", "SRC_INT_RESERVED_13", "SRC_EXT_CDN77", "SRC_EXT_GSL", "SRC_EXT_GSL_REPORT", "SRC_EXT_GSL_CORERO", "SRC_EXT_RETN", "SRC_EXT_RBL", "SRC_EXT_CERT", "SRC_EXT_SHADOWSERVER", "SRC_EXT_BGPTOOLS", "SRC_EXT_M_WEBFORM", "SRC_EXT_M_EMAIL", "SRC_EXT_M_MANUAL", "SRC_EXT_CYBERTIPLINE" ], "type": "string" }, "title": "Flags", "type": "array" }, "status": { "items": { "enum": [ "EVENT_PENDING", "EVENT_WAITING_DETAILS", "EVENT_ONGOING", "EVENT_COMPLETED", "RESOLUTION_IGNORED", "RESOLUTION_RESOLVED", "RESOLUTION_TERMINATED", "RESOLUTION_SUSPENDED", "RESOLUTION_FALSE_POSITIVE", "RESOLUTION_NOT_REQUIRED", "RESOLUTION_PENDING", "RESOLUTION_UNSPECIFIED", "DDOS_BGP_WITHDRAWN", "DDOS_BGP_OVERWRITTEN", "DDOS_BLACKHOLE", "DDOS_MITIGATED", "DDOS_NOT_MITIGATED", "DDOS_PARTIALLY_MITIGATED", "DDOS_FULLY_MITIGATED", "DDOS_UNSPECIFIED" ], "type": "string" }, "title": "Status", "type": "array" }, "affected_network": { "format": "ipvanynetwork", "title": "Affected Network", "type": "string" }, "source_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timezone of the source location, if available", "title": "Source Timezone" }, "start": { "format": "date-time", "title": "Start", "type": "string" }, "end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End" }, "source_key": { "maxLength": 16, "title": "Source Key", "type": "string" }, "source_event_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Event Id" }, "source_resource_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Resource Id" }, "source_location_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Location Id" }, "source_country": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "Source Country" }, "source_location": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Location" }, "target_country": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "Target Country" }, "target_location": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Target Location" }, "classification_key": { "maxLength": 64, "title": "Classification Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "affected_bps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Bps" }, "affected_pps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Pps" }, "relationships": { "items": { "$ref": "#/components/schemas/SecurityEventRelationshipSchema" }, "title": "Relationships", "type": "array" } }, "required": [ "id", "flags", "status", "affected_network", "start", "source_key", "classification_key", "relationships" ], "title": "SecurityEventFullSchema", "type": "object" }, "SecurityEventRelationshipSchema": { "properties": { "match_resouce_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Resouce Name" }, "match_resource_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Resource Link" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" }, "match_resource": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Match Resource" }, "match_type": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "match_value": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Match Value" } }, "title": "SecurityEventRelationshipSchema", "type": "object" }, "SecurityEventDetailSchema": { "properties": { "id": { "title": "Id", "type": "string" }, "flags": { "items": { "enum": [ "INCOMING", "OUTGOING", "NETWORK_HOST", "NETWORK_SUBNET", "TYPE_DDOS_ATTACK", "TYPE_PORT_SCAN", "TYPE_BRUTE_FORCE", "TYPE_VULNERABILITY", "TYPE_MALWARE", "TYPE_PHISHING", "TYPE_BOTNET", "TYPE_C2", "TYPE_SPAM", "TYPE_DMCA", "TYPE_COPYRIGHT", "TYPE_LEGAL", "TYPE_PORN", "TYPE_ANOMALY", "TYPE_OTHER", "TYPE_RPKI_INVALID", "TYPE_ROUTE_LEAK", "TYPE_ROUTE_HIJACK", "TYPE_ROUTE_ANOMALY", "TYPE_UNSPECIFIED", "TYPE_RESERVED_1", "TYPE_RESERVED_2", "TYPE_RESERVED_3", "TYPE_RESERVED_4", "TYPE_RESERVED_5", "GROUP_SINGLE", "GROUP_MULTIPLE", "GROUP_UNSPECIFIED", "GROUP_NON_AGGREGATED", "GROUP_AGGREGATED", "GROUP_ALL", "SRC_INTERNAL", "SRC_EXTERNAL", "SRC_APERMON", "SRC_FASTNETMON", "SRC_AKVORADO", "SRC_RESERVED_1", "SRC_RESERVED_2", "SRC_RESERVED_3", "SRC_RESERVED_4", "SRC_RESERVED_5", "SRC_RESERVED_6", "SRC_RESERVED_7", "SRC_RESERVED_8", "SRC_RESERVED_9", "SRC_RESERVED_10", "SRC_RESERVED_11", "SRC_RESERVED_12", "SRC_RESERVED_13", "SRC_CDN77", "SRC_GSL", "SRC_GSL_CORERO", "SRC_RETN", "SRC_RBL", "SRC_CERT", "SRC_SHADOWSERVER", "SRC_BGPTOOLS", "SRC_M_WEBFORM", "SRC_M_EMAIL", "SRC_M_MANUAL", "SRC_CYBERTIPLINE", "SRC_INT_APERMON", "SRC_INT_FASTNETMON", "SRC_INT_AKVORADO", "SRC_INT_RESERVED_1", "SRC_INT_RESERVED_2", "SRC_INT_RESERVED_3", "SRC_INT_RESERVED_4", "SRC_INT_RESERVED_5", "SRC_INT_RESERVED_6", "SRC_INT_RESERVED_7", "SRC_INT_RESERVED_8", "SRC_INT_RESERVED_9", "SRC_INT_RESERVED_10", "SRC_INT_RESERVED_11", "SRC_INT_RESERVED_12", "SRC_INT_RESERVED_13", "SRC_EXT_CDN77", "SRC_EXT_GSL", "SRC_EXT_GSL_REPORT", "SRC_EXT_GSL_CORERO", "SRC_EXT_RETN", "SRC_EXT_RBL", "SRC_EXT_CERT", "SRC_EXT_SHADOWSERVER", "SRC_EXT_BGPTOOLS", "SRC_EXT_M_WEBFORM", "SRC_EXT_M_EMAIL", "SRC_EXT_M_MANUAL", "SRC_EXT_CYBERTIPLINE" ], "type": "string" }, "title": "Flags", "type": "array" }, "status": { "items": { "enum": [ "EVENT_PENDING", "EVENT_WAITING_DETAILS", "EVENT_ONGOING", "EVENT_COMPLETED", "RESOLUTION_IGNORED", "RESOLUTION_RESOLVED", "RESOLUTION_TERMINATED", "RESOLUTION_SUSPENDED", "RESOLUTION_FALSE_POSITIVE", "RESOLUTION_NOT_REQUIRED", "RESOLUTION_PENDING", "RESOLUTION_UNSPECIFIED", "DDOS_BGP_WITHDRAWN", "DDOS_BGP_OVERWRITTEN", "DDOS_BLACKHOLE", "DDOS_MITIGATED", "DDOS_NOT_MITIGATED", "DDOS_PARTIALLY_MITIGATED", "DDOS_FULLY_MITIGATED", "DDOS_UNSPECIFIED" ], "type": "string" }, "title": "Status", "type": "array" }, "affected_network": { "format": "ipvanynetwork", "title": "Affected Network", "type": "string" }, "source_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timezone of the source location, if available", "title": "Source Timezone" }, "start": { "format": "date-time", "title": "Start", "type": "string" }, "end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "End" }, "source_key": { "maxLength": 16, "title": "Source Key", "type": "string" }, "source_event_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Event Id" }, "source_resource_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Resource Id" }, "source_location_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Location Id" }, "source_country": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "Source Country" }, "source_location": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Source Location" }, "target_country": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "Target Country" }, "target_location": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Target Location" }, "classification_key": { "maxLength": 64, "title": "Classification Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "affected_bps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Bps" }, "affected_pps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Pps" }, "parsed_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Parsed Data" }, "has_attachment": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Attachment" } }, "required": [ "id", "flags", "status", "affected_network", "start", "source_key", "classification_key" ], "title": "SecurityEventDetailSchema", "type": "object" }, "SecurityEventAttachmentMetaSchema": { "properties": { "url": { "description": "Attachment file URL", "examples": [ "https://uc1b.s3.misaka.io/ddos-reports/Report-1919.pdf?AWSAccessKeyId=&Signature=&Expires=" ], "format": "uri", "minLength": 1, "title": "Url", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Attachment name", "examples": [ "Report-1919.pdf" ], "title": "Name" }, "size": { "description": "Attachment size", "examples": [ 17384027 ], "title": "Size", "type": "integer" } }, "required": [ "url", "size" ], "title": "SecurityEventAttachmentMetaSchema", "type": "object" }, "EventTimeseriesSchema": { "properties": { "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "timestamp", "count" ], "title": "EventTimeseriesSchema", "type": "object" }, "PagedEventTimeseriesSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/EventTimeseriesSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedEventTimeseriesSchema", "type": "object" }, "ChartConfigSchema": { "properties": { "key": { "title": "Key", "type": "string" }, "label": { "title": "Label", "type": "string" }, "color": { "title": "Color", "type": "string" } }, "required": [ "key", "label", "color" ], "title": "ChartConfigSchema", "type": "object" }, "NetworkMetricChartSchema": { "properties": { "config": { "additionalProperties": { "$ref": "#/components/schemas/ChartConfigSchema" }, "title": "Config", "type": "object" }, "data": { "items": { "additionalProperties": true, "type": "object" }, "title": "Data", "type": "array" } }, "required": [ "config", "data" ], "title": "NetworkMetricChartSchema", "type": "object" }, "NetworkMetricSchema": { "properties": { "chart": { "$ref": "#/components/schemas/NetworkMetricChartSchema" } }, "required": [ "chart" ], "title": "NetworkMetricSchema", "type": "object" }, "NetworkFlowTimeseriesRequestSchema": { "properties": { "network": { "anyOf": [ { "format": "ipvanynetwork", "type": "string" }, { "type": "null" } ], "description": "CIDR", "title": "Network" }, "start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Start time", "title": "Start" }, "end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "End time", "title": "End" }, "limit": { "anyOf": [ { "maximum": 31, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": 30, "description": "Limit the number of results", "title": "Limit" } }, "title": "NetworkFlowTimeseriesRequestSchema", "type": "object" }, "LocationTimezoneSchema": { "properties": { "name": { "description": "Timezone name", "title": "Name", "type": "string" }, "offset": { "description": "Timezone offset in seconds", "title": "Offset", "type": "integer" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, "required": [ "name", "offset" ], "title": "LocationTimezoneSchema", "type": "object" }, "DDoSPrefixPolicyASNSchema": { "properties": { "asn": { "description": "ASN", "title": "Asn", "type": "integer" } }, "required": [ "asn" ], "title": "DDoSPrefixPolicyASNSchema", "type": "object" }, "DDoSPrefixPolicySchema": { "properties": { "prefix": { "description": "Prefix to protect", "format": "ipvanynetwork", "title": "Prefix", "type": "string" }, "asn": { "$ref": "#/components/schemas/DDoSPrefixPolicyASNSchema", "description": "ASN" }, "action": { "description": "Action to take when DDoS attack is detected on the prefix", "enum": [ "MITIGATE", "DROP", "BLACKHOLE", "RESERVED_1", "RESERVED_2", "RESERVED_3", "RESERVED_4", "RESERVED_5", "RESERVED_6", "RESERVED_7", "RESERVED_8", "RESERVED_9", "ACTION_DROP", "ACTION_BLACKHOLE", "ACTION_MITIGATE_BLACKHOLE", "ACTION_MITIGATE_DROP" ], "title": "Action", "type": "string" }, "sensitivity": { "description": "DDoS detection sensitivity", "enum": [ "STANDARD", "STRICT" ], "title": "Sensitivity", "type": "string" }, "force_inline": { "description": "Whether inline mitigation will always be forced for this prefix", "title": "Force Inline", "type": "boolean" }, "synproxy": { "description": "Whether TCP stateful protection should be used for this prefix", "title": "Synproxy", "type": "boolean" }, "extras": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Extra configuration", "title": "Extras" }, "extras_raw": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Raw GSL extras", "title": "Extras Raw" }, "count": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Number of DDoS events detected in the last 24 hours", "title": "Count" }, "reconciled": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the policy was last reconciled", "title": "Reconciled" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" } }, "required": [ "prefix", "asn", "action", "sensitivity", "force_inline", "synproxy", "extras", "count" ], "title": "DDoSPrefixPolicySchema", "type": "object" }, "PagedDDoSPrefixPolicySchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/DDoSPrefixPolicySchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedDDoSPrefixPolicySchema", "type": "object" }, "DDoSPrefixPolicyUpdateSchema": { "properties": { "action": { "anyOf": [ { "enum": [ "MITIGATE", "DROP", "BLACKHOLE", "RESERVED_1", "RESERVED_2", "RESERVED_3", "RESERVED_4", "RESERVED_5", "RESERVED_6", "RESERVED_7", "RESERVED_8", "RESERVED_9", "ACTION_DROP", "ACTION_BLACKHOLE", "ACTION_MITIGATE_BLACKHOLE", "ACTION_MITIGATE_DROP" ], "type": "string" }, { "type": "null" } ], "description": "Action to take when DDoS attack is detected on the prefix", "title": "Action" }, "sensitivity": { "anyOf": [ { "enum": [ "STANDARD", "STRICT" ], "type": "string" }, { "type": "null" } ], "description": "DDoS detection sensitivity", "title": "Sensitivity" }, "force_inline": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether inline mitigation will always be forced for this prefix", "title": "Force Inline" } }, "title": "DDoSPrefixPolicyUpdateSchema", "type": "object" }, "CrossConnectProviderDataSchema": { "properties": { "ibx": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Equinix IBX", "title": "Ibx" }, "z_side_ibx": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Z side IBX", "title": "Z Side Ibx" }, "final_z_side_patch_panel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Final Z side patch panel", "title": "Final Z Side Patch Panel" }, "final_z_side_port_a": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "Final Z side patch panel port A", "title": "Final Z Side Port A" }, "final_z_side_port_b": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "Final Z side patch panel port B", "title": "Final Z Side Port B" } }, "title": "CrossConnectProviderDataSchema", "type": "object" }, "CrossConnectSchema": { "properties": { "sid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the service", "title": "Sid" }, "cid": { "description": "Circuit ID", "title": "Cid", "type": "string" }, "description": { "description": "Description of the circuit", "title": "Description", "type": "string" }, "netbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Netbox ID", "title": "Netbox Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Status of the circuit", "title": "Status" }, "provider_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider of the circuit", "title": "Provider Slug" }, "provider_service_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider service type", "title": "Provider Service Type" }, "install_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date of installation", "title": "Install Date" }, "termination_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date of termination", "title": "Termination Date" }, "tags": { "description": "Tags of the circuit", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "side_a": { "$ref": "#/components/schemas/CrossConnectTerminationSchema", "description": "Side A of the cross connect" }, "side_z": { "$ref": "#/components/schemas/CrossConnectTerminationSchema", "description": "Side Z of the cross connect" }, "facility": { "anyOf": [ { "$ref": "#/components/schemas/FacilitySchema" }, { "type": "null" } ], "description": "Facility of the circuit" }, "raw_data": { "anyOf": [ { "$ref": "#/components/schemas/CrossConnectProviderDataSchema" }, { "type": "null" } ], "description": "Raw data from the provider" }, "monthly_recurring_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Monthly recurring cost", "title": "Monthly Recurring Cost" } }, "required": [ "cid", "description", "tags", "side_a", "side_z", "raw_data" ], "title": "CrossConnectSchema", "type": "object" }, "CrossConnectTerminationSchema": { "properties": { "xconnect_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cross connect ID", "title": "Xconnect Id" }, "site": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site slug of the termination", "title": "Site" }, "brief": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Brief description of the termination", "title": "Brief" } }, "title": "CrossConnectTerminationSchema", "type": "object" }, "FacilitySchema": { "properties": { "slug": { "description": "Slug of the facility", "title": "Slug", "type": "string" }, "name": { "description": "Name of the facility", "title": "Name", "type": "string" }, "facility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full nameof the facility", "title": "Facility" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timezone of the facility", "title": "Timezone" } }, "required": [ "slug", "name" ], "title": "FacilitySchema", "type": "object" }, "PagedCrossConnectSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CrossConnectSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedCrossConnectSchema", "type": "object" }, "DeviceAggregationSchema": { "properties": { "value": { "description": "Filter value", "title": "Value", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable label", "title": "Label" }, "count": { "description": "Number of matching devices", "title": "Count", "type": "integer" } }, "required": [ "value", "count" ], "title": "DeviceAggregationSchema", "type": "object" }, "DeviceGroupBySchema": { "properties": { "key": { "description": "Grouped field", "enum": [ "rack", "manufacturer", "model" ], "title": "Key", "type": "string" }, "values": { "description": "Available filter values", "items": { "$ref": "#/components/schemas/DeviceAggregationSchema" }, "title": "Values", "type": "array" } }, "required": [ "key", "values" ], "title": "DeviceGroupBySchema", "type": "object" }, "DeviceIPAddressSchema": { "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IP address with prefix length", "title": "Address" }, "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display value of the IP address", "title": "Display" } }, "title": "DeviceIPAddressSchema", "type": "object" }, "DeviceNamedObjectSchema": { "properties": { "name": { "description": "Name of the related object", "title": "Name", "type": "string" }, "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the related object", "title": "Display" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Slug of the related object", "title": "Slug" } }, "required": [ "name" ], "title": "DeviceNamedObjectSchema", "type": "object" }, "DeviceSchema": { "properties": { "id": { "description": "ID of the device", "title": "Id", "type": "integer" }, "sid": { "description": "SID of the device", "title": "Sid", "type": "string" }, "name": { "description": "Name of the device", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the device", "title": "Description" }, "device_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model of the device", "title": "Device Model" }, "device_model_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Slug of the device model", "title": "Device Model Slug" }, "manufacturer": { "anyOf": [ { "$ref": "#/components/schemas/ManufacturerSchema" }, { "type": "null" } ], "description": "Manufacturer of the device" }, "serial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Serial number of the device", "title": "Serial" }, "asset_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Asset tag of the device", "title": "Asset Tag" }, "rack": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Rack of the device", "title": "Rack" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Position of the device in the rack", "title": "Position" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device status", "title": "Status" }, "airflow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device airflow direction", "title": "Airflow" }, "role": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device role" }, "platform": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device platform" }, "site": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device site" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device location" }, "tenant": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device tenant" }, "cluster": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device cluster" }, "virtual_chassis": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Device virtual chassis" }, "parent_device": { "anyOf": [ { "$ref": "#/components/schemas/DeviceNamedObjectSchema" }, { "type": "null" } ], "description": "Parent device" }, "primary_ip4": { "anyOf": [ { "$ref": "#/components/schemas/DeviceIPAddressSchema" }, { "type": "null" } ], "description": "Primary IPv4 address" }, "primary_ip6": { "anyOf": [ { "$ref": "#/components/schemas/DeviceIPAddressSchema" }, { "type": "null" } ], "description": "Primary IPv6 address" }, "oob_ip": { "anyOf": [ { "$ref": "#/components/schemas/DeviceIPAddressSchema" }, { "type": "null" } ], "description": "Out-of-band management address" }, "device_type": { "anyOf": [ { "$ref": "#/components/schemas/DeviceTypeSchema" }, { "type": "null" } ], "description": "Device type details" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Device latitude", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Device longitude", "title": "Longitude" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device comments", "title": "Comments" } }, "required": [ "id", "sid", "name" ], "title": "DeviceSchema", "type": "object" }, "DeviceTypeSchema": { "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device model", "title": "Model" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device type slug", "title": "Slug" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer part number", "title": "Part Number" }, "u_height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Rack unit height", "title": "U Height" }, "is_full_depth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the device is full depth", "title": "Is Full Depth" }, "airflow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Default airflow direction", "title": "Airflow" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Device weight", "title": "Weight" }, "weight_unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Device weight unit", "title": "Weight Unit" }, "manufacturer": { "anyOf": [ { "$ref": "#/components/schemas/ManufacturerSchema" }, { "type": "null" } ], "description": "Device manufacturer" } }, "title": "DeviceTypeSchema", "type": "object" }, "ManufacturerSchema": { "properties": { "display": { "description": "Display name of the manufacturer", "title": "Display", "type": "string" }, "name": { "description": "Name of the manufacturer", "title": "Name", "type": "string" }, "slug": { "description": "Slug of the manufacturer", "title": "Slug", "type": "string" } }, "required": [ "display", "name", "slug" ], "title": "ManufacturerSchema", "type": "object" }, "PagedDeviceSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/DeviceSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedDeviceSchema", "type": "object" }, "PagedPortSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/PortSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedPortSchema", "type": "object" }, "PortSchema": { "properties": { "sid": { "description": "ID of the port", "title": "Sid", "type": "string" }, "netbox_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Netbox ID", "title": "Netbox Id" }, "name": { "description": "Name of the port on the device", "title": "Name", "type": "string" }, "description": { "description": "Description of the port", "title": "Description", "type": "string" }, "device": { "description": "Device name", "title": "Device", "type": "string" }, "enabled": { "description": "Whether the port is enabled", "title": "Enabled", "type": "boolean" }, "speed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Speed of the port in Mbps", "title": "Speed" } }, "required": [ "sid", "name", "description", "device", "enabled" ], "title": "PortSchema", "type": "object" }, "DeviceAttachmentSchema": { "properties": { "assignment_id": { "description": "Attachment assignment ID", "title": "Assignment Id", "type": "integer" }, "id": { "description": "Attachment ID", "title": "Id", "type": "integer" }, "name": { "description": "Attachment name", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Attachment description", "title": "Description" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "NetBox attachment file URL", "title": "File Url" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Attachment size in bytes", "title": "Size" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Attachment creation time", "title": "Created" }, "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Attachment update time", "title": "Last Updated" } }, "required": [ "assignment_id", "id", "name" ], "title": "DeviceAttachmentSchema", "type": "object" }, "PagedDeviceAttachmentSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/DeviceAttachmentSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedDeviceAttachmentSchema", "type": "object" }, "DeviceMetricsSchema": { "properties": { "cpu_usage": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "System CPU utilization" }, "free_memory": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Free system memory in bytes" }, "temperature": { "allOf": [ { "$ref": "#/components/schemas/PrometheusDataSeries" } ], "description": "Chassis temperatures grouped by sensor" }, "process_cpu": { "allOf": [ { "$ref": "#/components/schemas/PrometheusDataSeries" } ], "description": "CPU utilization grouped by monitored network process" }, "process_memory": { "allOf": [ { "$ref": "#/components/schemas/PrometheusDataSeries" } ], "description": "Memory usage grouped by monitored network process in bytes" }, "acl_matched_packets": { "allOf": [ { "$ref": "#/components/schemas/PrometheusDataSeries" } ], "description": "ACL matched packet rate grouped by ACL set and entry" } }, "title": "DeviceMetricsSchema", "type": "object" }, "PrometheusDataPoint": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "PrometheusDataPoints": { "items": { "$ref": "#/components/schemas/PrometheusDataPoint" }, "type": "array" }, "PrometheusDataSeries": { "additionalProperties": { "$ref": "#/components/schemas/PrometheusDataPoints" }, "type": "object" }, "PortInfoSchema": { "properties": { "router_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the router", "title": "Router Name" }, "interface_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the interface", "title": "Interface Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the port", "title": "Description" }, "physical_interface_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the physical interface", "title": "Physical Interface Name" }, "lanes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of lanes", "title": "Lanes" }, "speed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Speed of the port in Mbps", "title": "Speed" }, "site": { "anyOf": [ { "$ref": "#/components/schemas/FacilitySchema" }, { "type": "null" } ], "description": "Site of the port" } }, "title": "PortInfoSchema", "type": "object" }, "TransceiverLaneMetricsSchema": { "properties": { "TxBias": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "TxBias" }, "TxPower": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "TxPower" }, "RxPower": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "RxPower" } }, "title": "TransceiverLaneMetricsSchema", "type": "object" }, "TransceiverMetricsSchema": { "properties": { "Lane1": { "anyOf": [ { "$ref": "#/components/schemas/TransceiverLaneMetricsSchema" }, { "type": "null" } ], "description": "Metrics for lane 1" }, "Lane2": { "anyOf": [ { "$ref": "#/components/schemas/TransceiverLaneMetricsSchema" }, { "type": "null" } ], "description": "Metrics for lane 2" }, "Lane3": { "anyOf": [ { "$ref": "#/components/schemas/TransceiverLaneMetricsSchema" }, { "type": "null" } ], "description": "Metrics for lane 3" }, "Lane4": { "anyOf": [ { "$ref": "#/components/schemas/TransceiverLaneMetricsSchema" }, { "type": "null" } ], "description": "Metrics for lane 4" }, "low_warn": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Optical module low warning threshold" }, "high_warn": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Optical module high warning threshold" }, "temperature": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Optical module temperature" } }, "title": "TransceiverMetricsSchema", "type": "object" }, "PortUsageMetricsSchema": { "properties": { "in_throughput": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Inbound throughput" }, "in_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Inbound packets" }, "in_unicast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Unicast packets" }, "in_broadcast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Broadcast packets" }, "in_multicast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Multicast packets" }, "in_errors": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Inbound errors" }, "in_discards": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Inbound discards" }, "in_fcs_errors": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Inbound FCS errors" }, "out_throughput": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound throughput" }, "out_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound packets" }, "out_unicast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound unicast packets" }, "out_broadcast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound broadcast packets" }, "out_multicast_packets": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound multicast packets" }, "out_errors": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound errors" }, "out_discards": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound discards" }, "out_fcs_errors": { "anyOf": [ { "$ref": "#/components/schemas/PrometheusDataPoints" }, { "type": "null" } ], "description": "Outbound FCS errors" } }, "title": "PortUsageMetricsSchema", "type": "object" }, "PagedServiceSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ServiceSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedServiceSchema", "type": "object" }, "ServiceSchema": { "properties": { "sid": { "description": "Service ID", "title": "Sid", "type": "string" }, "name": { "description": "Name of the service", "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the service", "title": "Description" }, "product_name": { "description": "Name of the product", "title": "Product Name", "type": "string" }, "service_type": { "description": "Service type", "items": { "enum": [ "RECURRING", "ONE_TIME", "FINE", "IAAS", "NET", "COLOCATION", "CROSS_CONNECT", "POWER", "RACK", "REMOTE_HAND", "IAAS_RESERVED_5", "IAAS_RESERVED_6", "IAAS_RESERVED_7", "IAAS_RESERVED_8", "IAAS_RESERVED_9", "IP_TRANSIT", "IX_RESELLER", "L2", "NET_RESERVED_3", "NET_RESERVED_4", "NET_RESERVED_5", "NET_RESERVED_6", "NET_RESERVED_7", "NET_RESERVED_8", "NET_RESERVED_9", "IAAS_COLOCATION", "IAAS_CROSS_CONNECT", "IAAS_POWER", "IAAS_RACK", "IAAS_REMOTE_HAND", "IAAS_MISC_ONE_TIME", "IAAS_MISC_FINE", "NET_IP_TRANSIT", "NET_IX_RESELLER", "NET_L2" ], "type": "string" }, "title": "Service Type", "type": "array" }, "billing_type": { "description": "Billing type", "items": { "enum": [ "RECURRING", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "ANNUAL", "ONE_TIME", "RECURRING_MONTHLY", "RECURRING_QUARTERLY", "RECURRING_SEMIANNUAL", "RECURRING_ANNUAL" ], "type": "string" }, "title": "Billing Type", "type": "array" }, "recurring_cost": { "description": "Recurring cost", "title": "Recurring Cost", "type": "number" }, "one_time_cost": { "description": "One-time cost", "title": "One Time Cost", "type": "number" }, "billing_start_date": { "description": "Billing start date", "format": "date-time", "title": "Billing Start Date", "type": "string" }, "billing_end_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Billing end date", "title": "Billing End Date" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" } }, "required": [ "sid", "name", "product_name", "service_type", "billing_type", "recurring_cost", "one_time_cost", "billing_start_date" ], "title": "ServiceSchema", "type": "object" }, "PagedServiceBillablePortSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ServiceBillablePortSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedServiceBillablePortSchema", "type": "object" }, "ServiceBillablePortSchema": { "properties": { "sid": { "description": "Service ID", "title": "Sid", "type": "string" }, "service_name": { "description": "Service name", "title": "Service Name", "type": "string" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" }, "port_id": { "title": "Port Id", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "since": { "format": "date", "title": "Since", "type": "string" }, "until": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Until" } }, "required": [ "sid", "service_name", "port_id" ], "title": "ServiceBillablePortSchema", "type": "object" }, "ServiceBillablePortWriteSchema": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Billable port ID", "title": "Id" }, "port_id": { "description": "NetBox port/interface ID", "title": "Port Id", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the billable port", "title": "Description" }, "since": { "description": "Start date of billing", "format": "date", "title": "Since", "type": "string" }, "until": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "End date of billing", "title": "Until" } }, "required": [ "port_id", "since" ], "title": "ServiceBillablePortWriteSchema", "type": "object" }, "ASNOwnershipVerificationResultSchema": { "properties": { "asn": { "description": "Autonomous System Number", "title": "Asn", "type": "integer" }, "verified": { "description": "Whether ownership is verified", "title": "Verified", "type": "boolean" }, "reason": { "description": "Verification result reason", "title": "Reason", "type": "string" }, "matched_fields": { "description": "Matched ownership fields", "items": { "type": "string" }, "title": "Matched Fields", "type": "array" }, "as_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "WHOIS AS name", "title": "As Name" }, "org_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "WHOIS organization name", "title": "Org Name" }, "source": { "description": "Verification data source", "title": "Source", "type": "string" } }, "required": [ "asn", "verified", "reason", "matched_fields", "source" ], "title": "ASNOwnershipVerificationResultSchema", "type": "object" }, "BYOIPAnnouncement": { "properties": { "cidr": { "description": "CIDR", "title": "Cidr", "type": "string" }, "regions": { "description": "Regions", "items": { "type": "string" }, "title": "Regions", "type": "array" }, "status": { "description": "Status", "title": "Status", "type": "string" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" }, "prefix": { "format": "ipvanyaddress", "title": "Prefix", "type": "string" }, "prefixlen": { "title": "Prefixlen", "type": "integer" }, "origin_asn": { "title": "Origin Asn", "type": "integer" }, "irr_validated": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Irr Validated" }, "rpki_validated": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Rpki Validated" }, "loa_validated": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Loa Validated" }, "last_check": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Check" }, "last_check_result": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Last Check Result" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "created": { "format": "date-time", "title": "Created", "type": "string" } }, "required": [ "cidr", "regions", "status", "prefix", "prefixlen", "origin_asn", "created" ], "title": "BYOIPAnnouncement", "type": "object" }, "BYOIPAnnouncementChangeRequestSchema": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enable/disable announcement", "title": "Enabled" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Region to announce, needs to be a valid region slug", "title": "Region" } }, "required": [ "enabled" ], "title": "BYOIPAnnouncementChangeRequestSchema", "type": "object" }, "PagedBYOIPAnnouncement": { "properties": { "results": { "items": { "$ref": "#/components/schemas/BYOIPAnnouncement" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedBYOIPAnnouncement", "type": "object" }, "BYOIPAnnouncementRequestSchema": { "properties": { "prefixes": { "description": "Prefixes to announce", "items": { "format": "ipvanynetwork", "type": "string" }, "title": "Prefixes", "type": "array" }, "origin_asn": { "description": "ASN to announce", "title": "Origin Asn", "type": "integer" }, "region": { "description": "Region to announce, needs to be a valid region slug", "maxLength": 5, "minLength": 3, "title": "Region", "type": "string" }, "user": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "User ID", "title": "User" }, "loa_files": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "description": "LOA file ID", "title": "Loa Files" } }, "required": [ "prefixes", "origin_asn", "region" ], "title": "BYOIPAnnouncementRequestSchema", "type": "object" }, "BYOIPLOASchema": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "ID" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Name" }, "size": { "default": 0, "title": "Size", "type": "integer" } }, "title": "BYOIPLOASchema", "type": "object" }, "OwnerSchema": { "properties": { "id": { "description": "Owner ID", "title": "Id", "type": "integer" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name", "title": "Last Name" }, "email": { "description": "Email address", "title": "Email", "type": "string" }, "title": { "description": "Email address (alias)", "title": "Title", "type": "string" } }, "required": [ "id", "email", "title" ], "title": "OwnerSchema", "type": "object" }, "HypervisorMetricsSchema": { "properties": { "load1": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Load1" }, "load5": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Load5" }, "load15": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Load15" }, "cpu_usage": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Cpu Usage" }, "memory_usage": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Memory Usage" }, "filesystem_usage": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Filesystem Usage" }, "network_receive_bits": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Network Receive Bits" }, "network_transmit_bits": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Network Transmit Bits" }, "disk_read_bytes": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Disk Read Bytes" }, "disk_write_bytes": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Disk Write Bytes" }, "disk_read_iops": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Disk Read Iops" }, "disk_write_iops": { "anyOf": [ { "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Disk Write Iops" } }, "title": "HypervisorMetricsSchema", "type": "object" }, "HypervisorLiveMetricSchema": { "properties": { "id": { "title": "Id", "type": "integer" }, "cpu_usage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpu Usage" }, "memory_usage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Memory Usage" }, "memory_used": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Memory Used" }, "memory_cache_buffers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Memory Cache Buffers" }, "memory_free": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Memory Free" }, "observed_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Observed At" } }, "required": [ "id" ], "title": "HypervisorLiveMetricSchema", "type": "object" }, "AccountRegionThroughputSchema": { "properties": { "account": { "$ref": "#/components/schemas/AccountThroughputAccountSchema" }, "region": { "$ref": "#/components/schemas/AccountThroughputRegionSchema" }, "instance_count": { "title": "Instance Count", "type": "integer" }, "rx_bytes_per_second": { "title": "Rx Bytes Per Second", "type": "number" }, "tx_bytes_per_second": { "title": "Tx Bytes Per Second", "type": "number" }, "max_bytes_per_second": { "title": "Max Bytes Per Second", "type": "number" }, "p95_bytes_per_second": { "title": "P95 Bytes Per Second", "type": "number" }, "history": { "items": { "maxItems": 3, "minItems": 3, "prefixItems": [ { "type": "integer" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, "title": "History", "type": "array" } }, "required": [ "account", "region", "instance_count", "rx_bytes_per_second", "tx_bytes_per_second", "max_bytes_per_second", "p95_bytes_per_second", "history" ], "title": "AccountRegionThroughputSchema", "type": "object" }, "AccountThroughputAccountSchema": { "properties": { "id": { "title": "Id", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "name": { "title": "Name", "type": "string" }, "company": { "title": "Company", "type": "string" } }, "required": [ "id", "email", "name", "company" ], "title": "AccountThroughputAccountSchema", "type": "object" }, "AccountThroughputRegionSchema": { "properties": { "slug": { "title": "Slug", "type": "string" }, "name": { "title": "Name", "type": "string" }, "country_code": { "title": "Country Code", "type": "string" } }, "required": [ "slug", "name", "country_code" ], "title": "AccountThroughputRegionSchema", "type": "object" }, "AccountThroughputResponseSchema": { "properties": { "generated_at": { "title": "Generated At", "type": "integer" }, "period": { "enum": [ "24h", "month" ], "title": "Period", "type": "string" }, "range_start": { "title": "Range Start", "type": "integer" }, "range_end": { "title": "Range End", "type": "integer" }, "sample_step_seconds": { "title": "Sample Step Seconds", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/AccountRegionThroughputSchema" }, "title": "Results", "type": "array" } }, "required": [ "generated_at", "period", "range_start", "range_end", "sample_step_seconds", "results" ], "title": "AccountThroughputResponseSchema", "type": "object" }, "FullZoneSchema": { "properties": { "id": { "description": "Zone ID", "title": "Id", "type": "integer" }, "name": { "description": "Zone name", "title": "Name", "type": "string" }, "friendly_name": { "description": "Friendly name", "title": "Friendly Name", "type": "string" }, "comment": { "description": "Comment", "title": "Comment", "type": "string" }, "type": { "description": "Zone type", "enum": [ "PublicManagedZone", "PublicManagedIPv4ReverseZone", "PublicManagedIPv6ReverseZone", "PrivateManagedZone", "PrivateManagedIPv4ReverseZone", "PrivateManagedIPv6ReverseZone" ], "title": "Type", "type": "string" }, "alias_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alias of zone name", "title": "Alias Of" }, "enabled": { "description": "Enabled", "title": "Enabled", "type": "boolean" }, "dnssec": { "description": "DNSSEC enabled", "title": "Dnssec", "type": "boolean" }, "propagated": { "description": "Propagated", "title": "Propagated", "type": "boolean" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/OwnerSchema" }, { "type": "null" } ], "description": "Owner" } }, "required": [ "id", "name", "friendly_name", "comment", "type", "enabled", "dnssec", "propagated" ], "title": "FullZoneSchema", "type": "object" }, "PagedFullZoneSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/FullZoneSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedFullZoneSchema", "type": "object" }, "ZoneCreateSchema": { "properties": { "name": { "description": "Zone name", "title": "Name", "type": "string" }, "options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Zone options", "title": "Options" } }, "required": [ "name" ], "title": "ZoneCreateSchema", "type": "object" }, "ZoneSettingsSchema": { "properties": { "id": { "description": "Zone ID", "title": "Id", "type": "integer" }, "name": { "description": "Zone name", "title": "Name", "type": "string" }, "friendly_name": { "description": "Friendly name", "title": "Friendly Name", "type": "string" }, "comment": { "description": "Comment", "title": "Comment", "type": "string" }, "email": { "description": "Email", "title": "Email", "type": "string" }, "alias_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alias of zone name", "title": "Alias Of" }, "expiry": { "description": "Expiry", "title": "Expiry", "type": "integer" }, "nxdomain_ttl": { "description": "NXDOMAIN TTL", "title": "Nxdomain Ttl", "type": "integer" }, "default_ttl": { "description": "Default TTL", "title": "Default Ttl", "type": "integer" }, "refresh": { "description": "Refresh", "title": "Refresh", "type": "integer" }, "retry": { "description": "Retry", "title": "Retry", "type": "integer" }, "serial": { "description": "Serial", "title": "Serial", "type": "integer" }, "managed_soa": { "description": "Managed SOA", "title": "Managed Soa", "type": "boolean" }, "managed_acme": { "description": "Managed ACME", "title": "Managed Acme", "type": "boolean" }, "enabled": { "description": "Enabled", "title": "Enabled", "type": "boolean" }, "propagated": { "description": "Propagated", "title": "Propagated", "type": "boolean" } }, "required": [ "id", "name", "friendly_name", "comment", "email", "expiry", "nxdomain_ttl", "default_ttl", "refresh", "retry", "serial", "managed_soa", "managed_acme", "enabled", "propagated" ], "title": "ZoneSettingsSchema", "type": "object" }, "ZoneUpdateSchema": { "properties": { "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment", "title": "Comment" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email", "title": "Email" }, "expiry": { "anyOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "Expiry", "title": "Expiry" }, "nxdomain_ttl": { "anyOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "NXDOMAIN TTL", "title": "Nxdomain Ttl" }, "default_ttl": { "anyOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "Default TTL", "title": "Default Ttl" }, "refresh": { "anyOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "Refresh", "title": "Refresh" }, "retry": { "anyOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "Retry", "title": "Retry" }, "managed_soa": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Managed SOA", "title": "Managed Soa" }, "managed_acme": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Managed ACME", "title": "Managed Acme" }, "propagated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Propagated", "title": "Propagated" } }, "title": "ZoneUpdateSchema", "type": "object" }, "ZoneImportResponseSchema": { "properties": { "dry_run": { "description": "Dry run", "title": "Dry Run", "type": "boolean" }, "created": { "description": "Number of records created", "title": "Created", "type": "integer" }, "updated": { "description": "Number of records updated", "title": "Updated", "type": "integer" }, "deleted": { "description": "Number of records deleted", "title": "Deleted", "type": "integer" } }, "required": [ "dry_run", "created", "updated", "deleted" ], "title": "ZoneImportResponseSchema", "type": "object" }, "ZoneImportSchema": { "properties": { "data": { "description": "Zone data in text format", "title": "Data", "type": "string" }, "dry_run": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Dry run", "title": "Dry Run" }, "delete": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Delete records not in import", "title": "Delete" } }, "required": [ "data" ], "title": "ZoneImportSchema", "type": "object" }, "DNSSECSchema": { "properties": { "enabled": { "description": "DNSSEC enabled", "title": "Enabled", "type": "boolean" }, "generated": { "description": "DNSSEC generated", "title": "Generated", "type": "boolean" }, "keys": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "DNSSEC keys", "title": "Keys" }, "ds_records": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "DS records", "title": "Ds Records" } }, "required": [ "enabled", "generated" ], "title": "DNSSECSchema", "type": "object" }, "PagedRecordSetSchema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/RecordSetSchema" }, "title": "Results", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "results", "count" ], "title": "PagedRecordSetSchema", "type": "object" }, "RecordSetSchema": { "properties": { "name": { "description": "Record name", "title": "Name", "type": "string" }, "type": { "description": "Record type", "title": "Type", "type": "string" }, "ttl": { "description": "TTL", "title": "Ttl", "type": "integer" }, "enabled": { "description": "Enabled", "title": "Enabled", "type": "boolean" }, "protected": { "default": false, "description": "Protected", "title": "Protected", "type": "boolean" }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alias", "title": "Alias" }, "records": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Records", "title": "Records" }, "filters": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Filters", "title": "Filters" } }, "required": [ "name", "type", "ttl", "enabled" ], "title": "RecordSetSchema", "type": "object" }, "RecordSetCreateSchema": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Record name (from path)", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Record type (from path)", "title": "Type" }, "ttl": { "description": "TTL", "title": "Ttl", "type": "integer" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Enabled", "title": "Enabled" }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alias", "title": "Alias" }, "records": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Records", "title": "Records" }, "filters": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Filters", "title": "Filters" } }, "required": [ "ttl" ], "title": "RecordSetCreateSchema", "type": "object" }, "RecordSetUpdateSchema": { "properties": { "ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "TTL", "title": "Ttl" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enabled", "title": "Enabled" }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alias", "title": "Alias" }, "records": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Records", "title": "Records" }, "filters": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Filters", "title": "Filters" } }, "title": "RecordSetUpdateSchema", "type": "object" }, "FilterKeySchema": { "properties": { "key": { "description": "Filter key", "title": "Key", "type": "string" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Country code", "title": "Country" }, "name": { "description": "Display name", "title": "Name", "type": "string" } }, "required": [ "key", "name" ], "title": "FilterKeySchema", "type": "object" }, "PTRUpdateResponseSchema": { "properties": { "updated": { "additionalProperties": { "type": "string" }, "description": "Updated PTR records", "title": "Updated", "type": "object" }, "failed": { "additionalProperties": { "type": "string" }, "description": "Failed PTR records", "title": "Failed", "type": "object" } }, "required": [ "updated", "failed" ], "title": "PTRUpdateResponseSchema", "type": "object" }, "PTRUpdateSchema": { "properties": { "ptrs": { "additionalProperties": { "type": "string" }, "description": "PTR records mapping IP to hostname", "title": "Ptrs", "type": "object" } }, "required": [ "ptrs" ], "title": "PTRUpdateSchema", "type": "object" } }, "securitySchemes": { "Bearer": { "type": "http", "bearerFormat": "JWT", "description": "Bearer is only available for WebApp. Please use API tokens for programmatic access.", "scheme": "bearer" }, "AuthLegacyJWTBearer": { "type": "http", "bearerFormat": "JWT", "description": "Bearer is only available for WebApp. Please use API tokens for programmatic access.", "scheme": "bearer" }, "AuthLegacyBearerToken": { "type": "http", "bearerFormat": "JWT", "description": "Bearer is only available for WebApp. Please use API tokens for programmatic access.", "scheme": "bearer" }, "APIToken": { "type": "http", "bearerFormat": "JWT", "description": "Bearer is only available for WebApp. Please use API tokens for programmatic access.", "scheme": "token" } } }, "servers": [ { "url": "https://api.misaka.io" } ] }