{ "openapi": "3.0.3", "info": { "title": "EntGo Rest API", "version": "1.0.0" }, "paths": { "/campuses": { "summary": "List campus", "description": "List Campus entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Campus" ], "summary": "List campus", "description": "List Campus entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listCampus", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CampusSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CampusOrgIDEQ" }, { "$ref": "#/components/parameters/CampusOrgIDNEQ" }, { "$ref": "#/components/parameters/CampusOrgIDIn" }, { "$ref": "#/components/parameters/CampusOrgIDNotIn" }, { "$ref": "#/components/parameters/CampusAkaEQ" }, { "$ref": "#/components/parameters/CampusAkaNEQ" }, { "$ref": "#/components/parameters/CampusAkaIsNil" }, { "$ref": "#/components/parameters/CampusAkaIn" }, { "$ref": "#/components/parameters/CampusAkaNotIn" }, { "$ref": "#/components/parameters/CampusAkaEqualFold" }, { "$ref": "#/components/parameters/CampusAkaContains" }, { "$ref": "#/components/parameters/CampusAkaContainsFold" }, { "$ref": "#/components/parameters/CampusAkaHasPrefix" }, { "$ref": "#/components/parameters/CampusAkaHasSuffix" }, { "$ref": "#/components/parameters/CampusCityEQ" }, { "$ref": "#/components/parameters/CampusCityNEQ" }, { "$ref": "#/components/parameters/CampusCityIsNil" }, { "$ref": "#/components/parameters/CampusCityIn" }, { "$ref": "#/components/parameters/CampusCityNotIn" }, { "$ref": "#/components/parameters/CampusCityEqualFold" }, { "$ref": "#/components/parameters/CampusCityContains" }, { "$ref": "#/components/parameters/CampusCityContainsFold" }, { "$ref": "#/components/parameters/CampusCityHasPrefix" }, { "$ref": "#/components/parameters/CampusCityHasSuffix" }, { "$ref": "#/components/parameters/CampusCountryEQ" }, { "$ref": "#/components/parameters/CampusCountryNEQ" }, { "$ref": "#/components/parameters/CampusCountryIsNil" }, { "$ref": "#/components/parameters/CampusCountryIn" }, { "$ref": "#/components/parameters/CampusCountryNotIn" }, { "$ref": "#/components/parameters/CampusCountryEqualFold" }, { "$ref": "#/components/parameters/CampusCountryContains" }, { "$ref": "#/components/parameters/CampusCountryContainsFold" }, { "$ref": "#/components/parameters/CampusCountryHasPrefix" }, { "$ref": "#/components/parameters/CampusCountryHasSuffix" }, { "$ref": "#/components/parameters/CampusNameEQ" }, { "$ref": "#/components/parameters/CampusNameNEQ" }, { "$ref": "#/components/parameters/CampusNameIn" }, { "$ref": "#/components/parameters/CampusNameNotIn" }, { "$ref": "#/components/parameters/CampusNameEqualFold" }, { "$ref": "#/components/parameters/CampusNameContains" }, { "$ref": "#/components/parameters/CampusNameContainsFold" }, { "$ref": "#/components/parameters/CampusNameHasPrefix" }, { "$ref": "#/components/parameters/CampusNameHasSuffix" }, { "$ref": "#/components/parameters/CampusNameLongEQ" }, { "$ref": "#/components/parameters/CampusNameLongNEQ" }, { "$ref": "#/components/parameters/CampusNameLongIsNil" }, { "$ref": "#/components/parameters/CampusNameLongIn" }, { "$ref": "#/components/parameters/CampusNameLongNotIn" }, { "$ref": "#/components/parameters/CampusNameLongEqualFold" }, { "$ref": "#/components/parameters/CampusNameLongContains" }, { "$ref": "#/components/parameters/CampusNameLongContainsFold" }, { "$ref": "#/components/parameters/CampusNameLongHasPrefix" }, { "$ref": "#/components/parameters/CampusNameLongHasSuffix" }, { "$ref": "#/components/parameters/CampusStateEQ" }, { "$ref": "#/components/parameters/CampusStateNEQ" }, { "$ref": "#/components/parameters/CampusStateIsNil" }, { "$ref": "#/components/parameters/CampusStateIn" }, { "$ref": "#/components/parameters/CampusStateNotIn" }, { "$ref": "#/components/parameters/CampusStateEqualFold" }, { "$ref": "#/components/parameters/CampusStateContains" }, { "$ref": "#/components/parameters/CampusStateContainsFold" }, { "$ref": "#/components/parameters/CampusStateHasPrefix" }, { "$ref": "#/components/parameters/CampusStateHasSuffix" }, { "$ref": "#/components/parameters/CampusCreatedGT" }, { "$ref": "#/components/parameters/CampusCreatedGTE" }, { "$ref": "#/components/parameters/CampusCreatedLT" }, { "$ref": "#/components/parameters/CampusCreatedLTE" }, { "$ref": "#/components/parameters/CampusUpdatedGT" }, { "$ref": "#/components/parameters/CampusUpdatedGTE" }, { "$ref": "#/components/parameters/CampusUpdatedLT" }, { "$ref": "#/components/parameters/CampusUpdatedLTE" }, { "$ref": "#/components/parameters/CampusStatusEQ" }, { "$ref": "#/components/parameters/CampusStatusNEQ" }, { "$ref": "#/components/parameters/CampusStatusIn" }, { "$ref": "#/components/parameters/CampusStatusNotIn" }, { "$ref": "#/components/parameters/CampusStatusEqualFold" }, { "$ref": "#/components/parameters/CampusStatusContains" }, { "$ref": "#/components/parameters/CampusStatusContainsFold" }, { "$ref": "#/components/parameters/CampusStatusHasPrefix" }, { "$ref": "#/components/parameters/CampusStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Campus.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/campuses/{campusID}": { "summary": "Operate on a single Campus entity", "description": "Operate on a single Campus entity by its ID.", "get": { "tags": [ "Campus" ], "summary": "Retrieve a campus", "description": "Retrieve a single Campus entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCampus", "responses": { "200": { "description": "The requested Campus entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CampusID" } ] }, "/campuses/{campusID}/facilities": { "summary": "List a campuses associated facilities", "description": "List a campuses associated facilities (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Campus", "Facilities" ], "summary": "List a campuses associated facilities", "description": "List a campuses associated facilities (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listCampusFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/FacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/FacilityCampusIDEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDNEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDIn" }, { "$ref": "#/components/parameters/FacilityCampusIDNotIn" }, { "$ref": "#/components/parameters/FacilityOrgIDEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDNEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDIn" }, { "$ref": "#/components/parameters/FacilityOrgIDNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEQ" }, { "$ref": "#/components/parameters/FacilityAkaNEQ" }, { "$ref": "#/components/parameters/FacilityAkaIsNil" }, { "$ref": "#/components/parameters/FacilityAkaIn" }, { "$ref": "#/components/parameters/FacilityAkaNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEqualFold" }, { "$ref": "#/components/parameters/FacilityAkaContains" }, { "$ref": "#/components/parameters/FacilityAkaContainsFold" }, { "$ref": "#/components/parameters/FacilityAkaHasPrefix" }, { "$ref": "#/components/parameters/FacilityAkaHasSuffix" }, { "$ref": "#/components/parameters/FacilityCityEQ" }, { "$ref": "#/components/parameters/FacilityCityNEQ" }, { "$ref": "#/components/parameters/FacilityCityIsNil" }, { "$ref": "#/components/parameters/FacilityCityIn" }, { "$ref": "#/components/parameters/FacilityCityNotIn" }, { "$ref": "#/components/parameters/FacilityCityEqualFold" }, { "$ref": "#/components/parameters/FacilityCityContains" }, { "$ref": "#/components/parameters/FacilityCityContainsFold" }, { "$ref": "#/components/parameters/FacilityCityHasPrefix" }, { "$ref": "#/components/parameters/FacilityCityHasSuffix" }, { "$ref": "#/components/parameters/FacilityCountryEQ" }, { "$ref": "#/components/parameters/FacilityCountryNEQ" }, { "$ref": "#/components/parameters/FacilityCountryIsNil" }, { "$ref": "#/components/parameters/FacilityCountryIn" }, { "$ref": "#/components/parameters/FacilityCountryNotIn" }, { "$ref": "#/components/parameters/FacilityCountryEqualFold" }, { "$ref": "#/components/parameters/FacilityCountryContains" }, { "$ref": "#/components/parameters/FacilityCountryContainsFold" }, { "$ref": "#/components/parameters/FacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/FacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameEQ" }, { "$ref": "#/components/parameters/FacilityNameNEQ" }, { "$ref": "#/components/parameters/FacilityNameIn" }, { "$ref": "#/components/parameters/FacilityNameNotIn" }, { "$ref": "#/components/parameters/FacilityNameEqualFold" }, { "$ref": "#/components/parameters/FacilityNameContains" }, { "$ref": "#/components/parameters/FacilityNameContainsFold" }, { "$ref": "#/components/parameters/FacilityNameHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameLongEQ" }, { "$ref": "#/components/parameters/FacilityNameLongNEQ" }, { "$ref": "#/components/parameters/FacilityNameLongIsNil" }, { "$ref": "#/components/parameters/FacilityNameLongIn" }, { "$ref": "#/components/parameters/FacilityNameLongNotIn" }, { "$ref": "#/components/parameters/FacilityNameLongEqualFold" }, { "$ref": "#/components/parameters/FacilityNameLongContains" }, { "$ref": "#/components/parameters/FacilityNameLongContainsFold" }, { "$ref": "#/components/parameters/FacilityNameLongHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameLongHasSuffix" }, { "$ref": "#/components/parameters/FacilityStateEQ" }, { "$ref": "#/components/parameters/FacilityStateNEQ" }, { "$ref": "#/components/parameters/FacilityStateIsNil" }, { "$ref": "#/components/parameters/FacilityStateIn" }, { "$ref": "#/components/parameters/FacilityStateNotIn" }, { "$ref": "#/components/parameters/FacilityStateEqualFold" }, { "$ref": "#/components/parameters/FacilityStateContains" }, { "$ref": "#/components/parameters/FacilityStateContainsFold" }, { "$ref": "#/components/parameters/FacilityStateHasPrefix" }, { "$ref": "#/components/parameters/FacilityStateHasSuffix" }, { "$ref": "#/components/parameters/FacilityCreatedGT" }, { "$ref": "#/components/parameters/FacilityCreatedGTE" }, { "$ref": "#/components/parameters/FacilityCreatedLT" }, { "$ref": "#/components/parameters/FacilityCreatedLTE" }, { "$ref": "#/components/parameters/FacilityUpdatedGT" }, { "$ref": "#/components/parameters/FacilityUpdatedGTE" }, { "$ref": "#/components/parameters/FacilityUpdatedLT" }, { "$ref": "#/components/parameters/FacilityUpdatedLTE" }, { "$ref": "#/components/parameters/FacilityStatusEQ" }, { "$ref": "#/components/parameters/FacilityStatusNEQ" }, { "$ref": "#/components/parameters/FacilityStatusIn" }, { "$ref": "#/components/parameters/FacilityStatusNotIn" }, { "$ref": "#/components/parameters/FacilityStatusEqualFold" }, { "$ref": "#/components/parameters/FacilityStatusContains" }, { "$ref": "#/components/parameters/FacilityStatusContainsFold" }, { "$ref": "#/components/parameters/FacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/FacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested facilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CampusID" } ] }, "/campuses/{campusID}/organization": { "summary": "Get a campuses associated organization", "description": "Get a campuses associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Campus", "Organizations" ], "summary": "Get a campuses associated organization", "description": "Get a campuses associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCampusOrganization", "responses": { "200": { "description": "The requested organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CampusID" } ] }, "/carrier-facilities": { "summary": "List carrierfacilities", "description": "List CarrierFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "CarrierFacilities" ], "summary": "List carrierfacilities", "description": "List CarrierFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listCarrierFacilities", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CarrierFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameIsNil" }, { "$ref": "#/components/parameters/CarrierFacilityNameIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameContains" }, { "$ref": "#/components/parameters/CarrierFacilityNameContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContains" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested CarrierFacility.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/carrier-facilities/{carrierfacilityID}": { "summary": "Operate on a single CarrierFacility entity", "description": "Operate on a single CarrierFacility entity by its ID.", "get": { "tags": [ "CarrierFacilities" ], "summary": "Retrieve a carrierfacility", "description": "Retrieve a single CarrierFacility entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCarrierFacility", "responses": { "200": { "description": "The requested CarrierFacility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierFacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierFacilityID" } ] }, "/carrier-facilities/{carrierfacilityID}/carrier": { "summary": "Get a carrierfacilities associated carrier", "description": "Get a carrierfacilities associated carrier (Carrier entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "CarrierFacilities", "Carriers" ], "summary": "Get a carrierfacilities associated carrier", "description": "Get a carrierfacilities associated carrier (Carrier entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCarrierFacilityCarrier", "responses": { "200": { "description": "The requested carrier entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierFacilityID" } ] }, "/carrier-facilities/{carrierfacilityID}/facility": { "summary": "Get a carrierfacilities associated facility", "description": "Get a carrierfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "CarrierFacilities", "Facilities" ], "summary": "Get a carrierfacilities associated facility", "description": "Get a carrierfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCarrierFacilityFacility", "responses": { "200": { "description": "The requested facility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierFacilityID" } ] }, "/carriers": { "summary": "List carriers", "description": "List Carrier entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Carriers" ], "summary": "List carriers", "description": "List Carrier entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listCarriers", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CarrierSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CarrierOrgIDEQ" }, { "$ref": "#/components/parameters/CarrierOrgIDNEQ" }, { "$ref": "#/components/parameters/CarrierOrgIDIn" }, { "$ref": "#/components/parameters/CarrierOrgIDNotIn" }, { "$ref": "#/components/parameters/CarrierAkaEQ" }, { "$ref": "#/components/parameters/CarrierAkaNEQ" }, { "$ref": "#/components/parameters/CarrierAkaIsNil" }, { "$ref": "#/components/parameters/CarrierAkaIn" }, { "$ref": "#/components/parameters/CarrierAkaNotIn" }, { "$ref": "#/components/parameters/CarrierAkaEqualFold" }, { "$ref": "#/components/parameters/CarrierAkaContains" }, { "$ref": "#/components/parameters/CarrierAkaContainsFold" }, { "$ref": "#/components/parameters/CarrierAkaHasPrefix" }, { "$ref": "#/components/parameters/CarrierAkaHasSuffix" }, { "$ref": "#/components/parameters/CarrierNameEQ" }, { "$ref": "#/components/parameters/CarrierNameNEQ" }, { "$ref": "#/components/parameters/CarrierNameIn" }, { "$ref": "#/components/parameters/CarrierNameNotIn" }, { "$ref": "#/components/parameters/CarrierNameEqualFold" }, { "$ref": "#/components/parameters/CarrierNameContains" }, { "$ref": "#/components/parameters/CarrierNameContainsFold" }, { "$ref": "#/components/parameters/CarrierNameHasPrefix" }, { "$ref": "#/components/parameters/CarrierNameHasSuffix" }, { "$ref": "#/components/parameters/CarrierNameLongEQ" }, { "$ref": "#/components/parameters/CarrierNameLongNEQ" }, { "$ref": "#/components/parameters/CarrierNameLongIsNil" }, { "$ref": "#/components/parameters/CarrierNameLongIn" }, { "$ref": "#/components/parameters/CarrierNameLongNotIn" }, { "$ref": "#/components/parameters/CarrierNameLongEqualFold" }, { "$ref": "#/components/parameters/CarrierNameLongContains" }, { "$ref": "#/components/parameters/CarrierNameLongContainsFold" }, { "$ref": "#/components/parameters/CarrierNameLongHasPrefix" }, { "$ref": "#/components/parameters/CarrierNameLongHasSuffix" }, { "$ref": "#/components/parameters/CarrierCreatedGT" }, { "$ref": "#/components/parameters/CarrierCreatedGTE" }, { "$ref": "#/components/parameters/CarrierCreatedLT" }, { "$ref": "#/components/parameters/CarrierCreatedLTE" }, { "$ref": "#/components/parameters/CarrierUpdatedGT" }, { "$ref": "#/components/parameters/CarrierUpdatedGTE" }, { "$ref": "#/components/parameters/CarrierUpdatedLT" }, { "$ref": "#/components/parameters/CarrierUpdatedLTE" }, { "$ref": "#/components/parameters/CarrierStatusEQ" }, { "$ref": "#/components/parameters/CarrierStatusNEQ" }, { "$ref": "#/components/parameters/CarrierStatusIn" }, { "$ref": "#/components/parameters/CarrierStatusNotIn" }, { "$ref": "#/components/parameters/CarrierStatusEqualFold" }, { "$ref": "#/components/parameters/CarrierStatusContains" }, { "$ref": "#/components/parameters/CarrierStatusContainsFold" }, { "$ref": "#/components/parameters/CarrierStatusHasPrefix" }, { "$ref": "#/components/parameters/CarrierStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Carrier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/carriers/{carrierID}": { "summary": "Operate on a single Carrier entity", "description": "Operate on a single Carrier entity by its ID.", "get": { "tags": [ "Carriers" ], "summary": "Retrieve a carrier", "description": "Retrieve a single Carrier entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCarrier", "responses": { "200": { "description": "The requested Carrier entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierID" } ] }, "/carriers/{carrierID}/carrier-facilities": { "summary": "List a carriers associated carrierFacilities", "description": "List a carriers associated carrierFacilities (CarrierFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Carriers", "CarrierFacilities" ], "summary": "List a carriers associated carrierFacilities", "description": "List a carriers associated carrierFacilities (CarrierFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listCarrierCarrierFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CarrierFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameIsNil" }, { "$ref": "#/components/parameters/CarrierFacilityNameIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameContains" }, { "$ref": "#/components/parameters/CarrierFacilityNameContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContains" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested carrierFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierCarrierFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierID" } ] }, "/carriers/{carrierID}/organization": { "summary": "Get a carriers associated organization", "description": "Get a carriers associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Carriers", "Organizations" ], "summary": "Get a carriers associated organization", "description": "Get a carriers associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getCarrierOrganization", "responses": { "200": { "description": "The requested organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/CarrierID" } ] }, "/facilities": { "summary": "List facilities", "description": "List Facility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities" ], "summary": "List facilities", "description": "List Facility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listFacilities", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/FacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/FacilityCampusIDEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDNEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDIn" }, { "$ref": "#/components/parameters/FacilityCampusIDNotIn" }, { "$ref": "#/components/parameters/FacilityOrgIDEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDNEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDIn" }, { "$ref": "#/components/parameters/FacilityOrgIDNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEQ" }, { "$ref": "#/components/parameters/FacilityAkaNEQ" }, { "$ref": "#/components/parameters/FacilityAkaIsNil" }, { "$ref": "#/components/parameters/FacilityAkaIn" }, { "$ref": "#/components/parameters/FacilityAkaNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEqualFold" }, { "$ref": "#/components/parameters/FacilityAkaContains" }, { "$ref": "#/components/parameters/FacilityAkaContainsFold" }, { "$ref": "#/components/parameters/FacilityAkaHasPrefix" }, { "$ref": "#/components/parameters/FacilityAkaHasSuffix" }, { "$ref": "#/components/parameters/FacilityCityEQ" }, { "$ref": "#/components/parameters/FacilityCityNEQ" }, { "$ref": "#/components/parameters/FacilityCityIsNil" }, { "$ref": "#/components/parameters/FacilityCityIn" }, { "$ref": "#/components/parameters/FacilityCityNotIn" }, { "$ref": "#/components/parameters/FacilityCityEqualFold" }, { "$ref": "#/components/parameters/FacilityCityContains" }, { "$ref": "#/components/parameters/FacilityCityContainsFold" }, { "$ref": "#/components/parameters/FacilityCityHasPrefix" }, { "$ref": "#/components/parameters/FacilityCityHasSuffix" }, { "$ref": "#/components/parameters/FacilityCountryEQ" }, { "$ref": "#/components/parameters/FacilityCountryNEQ" }, { "$ref": "#/components/parameters/FacilityCountryIsNil" }, { "$ref": "#/components/parameters/FacilityCountryIn" }, { "$ref": "#/components/parameters/FacilityCountryNotIn" }, { "$ref": "#/components/parameters/FacilityCountryEqualFold" }, { "$ref": "#/components/parameters/FacilityCountryContains" }, { "$ref": "#/components/parameters/FacilityCountryContainsFold" }, { "$ref": "#/components/parameters/FacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/FacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameEQ" }, { "$ref": "#/components/parameters/FacilityNameNEQ" }, { "$ref": "#/components/parameters/FacilityNameIn" }, { "$ref": "#/components/parameters/FacilityNameNotIn" }, { "$ref": "#/components/parameters/FacilityNameEqualFold" }, { "$ref": "#/components/parameters/FacilityNameContains" }, { "$ref": "#/components/parameters/FacilityNameContainsFold" }, { "$ref": "#/components/parameters/FacilityNameHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameLongEQ" }, { "$ref": "#/components/parameters/FacilityNameLongNEQ" }, { "$ref": "#/components/parameters/FacilityNameLongIsNil" }, { "$ref": "#/components/parameters/FacilityNameLongIn" }, { "$ref": "#/components/parameters/FacilityNameLongNotIn" }, { "$ref": "#/components/parameters/FacilityNameLongEqualFold" }, { "$ref": "#/components/parameters/FacilityNameLongContains" }, { "$ref": "#/components/parameters/FacilityNameLongContainsFold" }, { "$ref": "#/components/parameters/FacilityNameLongHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameLongHasSuffix" }, { "$ref": "#/components/parameters/FacilityStateEQ" }, { "$ref": "#/components/parameters/FacilityStateNEQ" }, { "$ref": "#/components/parameters/FacilityStateIsNil" }, { "$ref": "#/components/parameters/FacilityStateIn" }, { "$ref": "#/components/parameters/FacilityStateNotIn" }, { "$ref": "#/components/parameters/FacilityStateEqualFold" }, { "$ref": "#/components/parameters/FacilityStateContains" }, { "$ref": "#/components/parameters/FacilityStateContainsFold" }, { "$ref": "#/components/parameters/FacilityStateHasPrefix" }, { "$ref": "#/components/parameters/FacilityStateHasSuffix" }, { "$ref": "#/components/parameters/FacilityCreatedGT" }, { "$ref": "#/components/parameters/FacilityCreatedGTE" }, { "$ref": "#/components/parameters/FacilityCreatedLT" }, { "$ref": "#/components/parameters/FacilityCreatedLTE" }, { "$ref": "#/components/parameters/FacilityUpdatedGT" }, { "$ref": "#/components/parameters/FacilityUpdatedGTE" }, { "$ref": "#/components/parameters/FacilityUpdatedLT" }, { "$ref": "#/components/parameters/FacilityUpdatedLTE" }, { "$ref": "#/components/parameters/FacilityStatusEQ" }, { "$ref": "#/components/parameters/FacilityStatusNEQ" }, { "$ref": "#/components/parameters/FacilityStatusIn" }, { "$ref": "#/components/parameters/FacilityStatusNotIn" }, { "$ref": "#/components/parameters/FacilityStatusEqualFold" }, { "$ref": "#/components/parameters/FacilityStatusContains" }, { "$ref": "#/components/parameters/FacilityStatusContainsFold" }, { "$ref": "#/components/parameters/FacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/FacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Facility.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/facilities/{facilityID}": { "summary": "Operate on a single Facility entity", "description": "Operate on a single Facility entity by its ID.", "get": { "tags": [ "Facilities" ], "summary": "Retrieve a facility", "description": "Retrieve a single Facility entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getFacility", "responses": { "200": { "description": "The requested Facility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/facilities/{facilityID}/campus": { "summary": "Get a facilities associated campus", "description": "Get a facilities associated campus (Campus entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities", "Campus" ], "summary": "Get a facilities associated campus", "description": "Get a facilities associated campus (Campus entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getFacilityCampus", "responses": { "200": { "description": "The requested campus entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/facilities/{facilityID}/carrier-facilities": { "summary": "List a facilities associated carrierFacilities", "description": "List a facilities associated carrierFacilities (CarrierFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities", "CarrierFacilities" ], "summary": "List a facilities associated carrierFacilities", "description": "List a facilities associated carrierFacilities (CarrierFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listFacilityCarrierFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CarrierFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityCarrierIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDIn" }, { "$ref": "#/components/parameters/CarrierFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityNameIsNil" }, { "$ref": "#/components/parameters/CarrierFacilityNameIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityNameEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameContains" }, { "$ref": "#/components/parameters/CarrierFacilityNameContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityCreatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLT" }, { "$ref": "#/components/parameters/CarrierFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNEQ" }, { "$ref": "#/components/parameters/CarrierFacilityStatusIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusNotIn" }, { "$ref": "#/components/parameters/CarrierFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContains" }, { "$ref": "#/components/parameters/CarrierFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/CarrierFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested carrierFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityCarrierFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/facilities/{facilityID}/ix-facilities": { "summary": "List a facilities associated ixFacilities", "description": "List a facilities associated ixFacilities (IxFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities", "IxFacilities" ], "summary": "List a facilities associated ixFacilities", "description": "List a facilities associated ixFacilities (IxFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listFacilityIxFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxFacilityFacIDEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDIn" }, { "$ref": "#/components/parameters/IxFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEQ" }, { "$ref": "#/components/parameters/IxFacilityNameNEQ" }, { "$ref": "#/components/parameters/IxFacilityNameIsNil" }, { "$ref": "#/components/parameters/IxFacilityNameIn" }, { "$ref": "#/components/parameters/IxFacilityNameNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEqualFold" }, { "$ref": "#/components/parameters/IxFacilityNameContains" }, { "$ref": "#/components/parameters/IxFacilityNameContainsFold" }, { "$ref": "#/components/parameters/IxFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCityEQ" }, { "$ref": "#/components/parameters/IxFacilityCityNEQ" }, { "$ref": "#/components/parameters/IxFacilityCityIsNil" }, { "$ref": "#/components/parameters/IxFacilityCityIn" }, { "$ref": "#/components/parameters/IxFacilityCityNotIn" }, { "$ref": "#/components/parameters/IxFacilityCityEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCityContains" }, { "$ref": "#/components/parameters/IxFacilityCityContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCountryEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryNEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryIsNil" }, { "$ref": "#/components/parameters/IxFacilityCountryIn" }, { "$ref": "#/components/parameters/IxFacilityCountryNotIn" }, { "$ref": "#/components/parameters/IxFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCountryContains" }, { "$ref": "#/components/parameters/IxFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCreatedGT" }, { "$ref": "#/components/parameters/IxFacilityCreatedGTE" }, { "$ref": "#/components/parameters/IxFacilityCreatedLT" }, { "$ref": "#/components/parameters/IxFacilityCreatedLTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/IxFacilityStatusEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusNEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusIn" }, { "$ref": "#/components/parameters/IxFacilityStatusNotIn" }, { "$ref": "#/components/parameters/IxFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/IxFacilityStatusContains" }, { "$ref": "#/components/parameters/IxFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/IxFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested ixFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityIxFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/facilities/{facilityID}/network-facilities": { "summary": "List a facilities associated networkFacilities", "description": "List a facilities associated networkFacilities (NetworkFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities", "NetworkFacilities" ], "summary": "List a facilities associated networkFacilities", "description": "List a facilities associated networkFacilities (NetworkFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listFacilityNetworkFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityNameIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameContains" }, { "$ref": "#/components/parameters/NetworkFacilityNameContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCityEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCityIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityContains" }, { "$ref": "#/components/parameters/NetworkFacilityCityContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContains" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContains" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested networkFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityNetworkFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/facilities/{facilityID}/organization": { "summary": "Get a facilities associated organization", "description": "Get a facilities associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Facilities", "Organizations" ], "summary": "Get a facilities associated organization", "description": "Get a facilities associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getFacilityOrganization", "responses": { "200": { "description": "The requested organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/FacilityID" } ] }, "/internet-exchanges": { "summary": "List internetexchanges", "description": "List InternetExchange entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "InternetExchanges" ], "summary": "List internetexchanges", "description": "List InternetExchange entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listInternetExchanges", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/InternetExchangeSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDEQ" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDNEQ" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDIn" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDNotIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaEQ" }, { "$ref": "#/components/parameters/InternetExchangeAkaNEQ" }, { "$ref": "#/components/parameters/InternetExchangeAkaIsNil" }, { "$ref": "#/components/parameters/InternetExchangeAkaIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaNotIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeAkaContains" }, { "$ref": "#/components/parameters/InternetExchangeAkaContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeAkaHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeAkaHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCityEQ" }, { "$ref": "#/components/parameters/InternetExchangeCityNEQ" }, { "$ref": "#/components/parameters/InternetExchangeCityIsNil" }, { "$ref": "#/components/parameters/InternetExchangeCityIn" }, { "$ref": "#/components/parameters/InternetExchangeCityNotIn" }, { "$ref": "#/components/parameters/InternetExchangeCityEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeCityContains" }, { "$ref": "#/components/parameters/InternetExchangeCityContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeCityHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeCityHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCountryEQ" }, { "$ref": "#/components/parameters/InternetExchangeCountryNEQ" }, { "$ref": "#/components/parameters/InternetExchangeCountryIsNil" }, { "$ref": "#/components/parameters/InternetExchangeCountryIn" }, { "$ref": "#/components/parameters/InternetExchangeCountryNotIn" }, { "$ref": "#/components/parameters/InternetExchangeCountryEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeCountryContains" }, { "$ref": "#/components/parameters/InternetExchangeCountryContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeCountryHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeCountryHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeNameEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameNEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameIn" }, { "$ref": "#/components/parameters/InternetExchangeNameNotIn" }, { "$ref": "#/components/parameters/InternetExchangeNameEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeNameContains" }, { "$ref": "#/components/parameters/InternetExchangeNameContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeNameHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeNameHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeNameLongEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameLongNEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameLongIsNil" }, { "$ref": "#/components/parameters/InternetExchangeNameLongIn" }, { "$ref": "#/components/parameters/InternetExchangeNameLongNotIn" }, { "$ref": "#/components/parameters/InternetExchangeNameLongEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeNameLongContains" }, { "$ref": "#/components/parameters/InternetExchangeNameLongContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeNameLongHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeNameLongHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCreatedGT" }, { "$ref": "#/components/parameters/InternetExchangeCreatedGTE" }, { "$ref": "#/components/parameters/InternetExchangeCreatedLT" }, { "$ref": "#/components/parameters/InternetExchangeCreatedLTE" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedGT" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedGTE" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedLT" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedLTE" }, { "$ref": "#/components/parameters/InternetExchangeStatusEQ" }, { "$ref": "#/components/parameters/InternetExchangeStatusNEQ" }, { "$ref": "#/components/parameters/InternetExchangeStatusIn" }, { "$ref": "#/components/parameters/InternetExchangeStatusNotIn" }, { "$ref": "#/components/parameters/InternetExchangeStatusEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeStatusContains" }, { "$ref": "#/components/parameters/InternetExchangeStatusContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeStatusHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeStatusHasSuffix" } ], "responses": { "200": { "description": "The requested InternetExchange.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/internet-exchanges/{internetexchangeID}": { "summary": "Operate on a single InternetExchange entity", "description": "Operate on a single InternetExchange entity by its ID.", "get": { "tags": [ "InternetExchanges" ], "summary": "Retrieve a internetexchange", "description": "Retrieve a single InternetExchange entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getInternetExchange", "responses": { "200": { "description": "The requested InternetExchange entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/InternetExchangeID" } ] }, "/internet-exchanges/{internetexchangeID}/ix-facilities": { "summary": "List a internetexchanges associated ixFacilities", "description": "List a internetexchanges associated ixFacilities (IxFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "InternetExchanges", "IxFacilities" ], "summary": "List a internetexchanges associated ixFacilities", "description": "List a internetexchanges associated ixFacilities (IxFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listInternetExchangeIxFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxFacilityFacIDEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDIn" }, { "$ref": "#/components/parameters/IxFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEQ" }, { "$ref": "#/components/parameters/IxFacilityNameNEQ" }, { "$ref": "#/components/parameters/IxFacilityNameIsNil" }, { "$ref": "#/components/parameters/IxFacilityNameIn" }, { "$ref": "#/components/parameters/IxFacilityNameNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEqualFold" }, { "$ref": "#/components/parameters/IxFacilityNameContains" }, { "$ref": "#/components/parameters/IxFacilityNameContainsFold" }, { "$ref": "#/components/parameters/IxFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCityEQ" }, { "$ref": "#/components/parameters/IxFacilityCityNEQ" }, { "$ref": "#/components/parameters/IxFacilityCityIsNil" }, { "$ref": "#/components/parameters/IxFacilityCityIn" }, { "$ref": "#/components/parameters/IxFacilityCityNotIn" }, { "$ref": "#/components/parameters/IxFacilityCityEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCityContains" }, { "$ref": "#/components/parameters/IxFacilityCityContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCountryEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryNEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryIsNil" }, { "$ref": "#/components/parameters/IxFacilityCountryIn" }, { "$ref": "#/components/parameters/IxFacilityCountryNotIn" }, { "$ref": "#/components/parameters/IxFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCountryContains" }, { "$ref": "#/components/parameters/IxFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCreatedGT" }, { "$ref": "#/components/parameters/IxFacilityCreatedGTE" }, { "$ref": "#/components/parameters/IxFacilityCreatedLT" }, { "$ref": "#/components/parameters/IxFacilityCreatedLTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/IxFacilityStatusEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusNEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusIn" }, { "$ref": "#/components/parameters/IxFacilityStatusNotIn" }, { "$ref": "#/components/parameters/IxFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/IxFacilityStatusContains" }, { "$ref": "#/components/parameters/IxFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/IxFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested ixFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeIxFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/InternetExchangeID" } ] }, "/internet-exchanges/{internetexchangeID}/ix-lans": { "summary": "List a internetexchanges associated ixLans", "description": "List a internetexchanges associated ixLans (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "InternetExchanges", "IxLans" ], "summary": "List a internetexchanges associated ixLans", "description": "List a internetexchanges associated ixLans (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listInternetExchangeIxLans", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxLanSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxLanIxIDEQ" }, { "$ref": "#/components/parameters/IxLanIxIDNEQ" }, { "$ref": "#/components/parameters/IxLanIxIDIn" }, { "$ref": "#/components/parameters/IxLanIxIDNotIn" }, { "$ref": "#/components/parameters/IxLanNameEQ" }, { "$ref": "#/components/parameters/IxLanNameNEQ" }, { "$ref": "#/components/parameters/IxLanNameIsNil" }, { "$ref": "#/components/parameters/IxLanNameIn" }, { "$ref": "#/components/parameters/IxLanNameNotIn" }, { "$ref": "#/components/parameters/IxLanNameEqualFold" }, { "$ref": "#/components/parameters/IxLanNameContains" }, { "$ref": "#/components/parameters/IxLanNameContainsFold" }, { "$ref": "#/components/parameters/IxLanNameHasPrefix" }, { "$ref": "#/components/parameters/IxLanNameHasSuffix" }, { "$ref": "#/components/parameters/IxLanCreatedGT" }, { "$ref": "#/components/parameters/IxLanCreatedGTE" }, { "$ref": "#/components/parameters/IxLanCreatedLT" }, { "$ref": "#/components/parameters/IxLanCreatedLTE" }, { "$ref": "#/components/parameters/IxLanUpdatedGT" }, { "$ref": "#/components/parameters/IxLanUpdatedGTE" }, { "$ref": "#/components/parameters/IxLanUpdatedLT" }, { "$ref": "#/components/parameters/IxLanUpdatedLTE" }, { "$ref": "#/components/parameters/IxLanStatusEQ" }, { "$ref": "#/components/parameters/IxLanStatusNEQ" }, { "$ref": "#/components/parameters/IxLanStatusIn" }, { "$ref": "#/components/parameters/IxLanStatusNotIn" }, { "$ref": "#/components/parameters/IxLanStatusEqualFold" }, { "$ref": "#/components/parameters/IxLanStatusContains" }, { "$ref": "#/components/parameters/IxLanStatusContainsFold" }, { "$ref": "#/components/parameters/IxLanStatusHasPrefix" }, { "$ref": "#/components/parameters/IxLanStatusHasSuffix" } ], "responses": { "200": { "description": "The requested ixLans.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeIxLanList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/InternetExchangeID" } ] }, "/internet-exchanges/{internetexchangeID}/organization": { "summary": "Get a internetexchanges associated organization", "description": "Get a internetexchanges associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "InternetExchanges", "Organizations" ], "summary": "Get a internetexchanges associated organization", "description": "Get a internetexchanges associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getInternetExchangeOrganization", "responses": { "200": { "description": "The requested organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/InternetExchangeID" } ] }, "/ix-facilities": { "summary": "List ixfacilities", "description": "List IxFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxFacilities" ], "summary": "List ixfacilities", "description": "List IxFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listIxFacilities", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxFacilityFacIDEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityFacIDIn" }, { "$ref": "#/components/parameters/IxFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDNEQ" }, { "$ref": "#/components/parameters/IxFacilityIxIDIn" }, { "$ref": "#/components/parameters/IxFacilityIxIDNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEQ" }, { "$ref": "#/components/parameters/IxFacilityNameNEQ" }, { "$ref": "#/components/parameters/IxFacilityNameIsNil" }, { "$ref": "#/components/parameters/IxFacilityNameIn" }, { "$ref": "#/components/parameters/IxFacilityNameNotIn" }, { "$ref": "#/components/parameters/IxFacilityNameEqualFold" }, { "$ref": "#/components/parameters/IxFacilityNameContains" }, { "$ref": "#/components/parameters/IxFacilityNameContainsFold" }, { "$ref": "#/components/parameters/IxFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCityEQ" }, { "$ref": "#/components/parameters/IxFacilityCityNEQ" }, { "$ref": "#/components/parameters/IxFacilityCityIsNil" }, { "$ref": "#/components/parameters/IxFacilityCityIn" }, { "$ref": "#/components/parameters/IxFacilityCityNotIn" }, { "$ref": "#/components/parameters/IxFacilityCityEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCityContains" }, { "$ref": "#/components/parameters/IxFacilityCityContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCountryEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryNEQ" }, { "$ref": "#/components/parameters/IxFacilityCountryIsNil" }, { "$ref": "#/components/parameters/IxFacilityCountryIn" }, { "$ref": "#/components/parameters/IxFacilityCountryNotIn" }, { "$ref": "#/components/parameters/IxFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/IxFacilityCountryContains" }, { "$ref": "#/components/parameters/IxFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/IxFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/IxFacilityCreatedGT" }, { "$ref": "#/components/parameters/IxFacilityCreatedGTE" }, { "$ref": "#/components/parameters/IxFacilityCreatedLT" }, { "$ref": "#/components/parameters/IxFacilityCreatedLTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLT" }, { "$ref": "#/components/parameters/IxFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/IxFacilityStatusEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusNEQ" }, { "$ref": "#/components/parameters/IxFacilityStatusIn" }, { "$ref": "#/components/parameters/IxFacilityStatusNotIn" }, { "$ref": "#/components/parameters/IxFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/IxFacilityStatusContains" }, { "$ref": "#/components/parameters/IxFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/IxFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/IxFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested IxFacility.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/ix-facilities/{ixfacilityID}": { "summary": "Operate on a single IxFacility entity", "description": "Operate on a single IxFacility entity by its ID.", "get": { "tags": [ "IxFacilities" ], "summary": "Retrieve a ixfacility", "description": "Retrieve a single IxFacility entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxFacility", "responses": { "200": { "description": "The requested IxFacility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxFacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxFacilityID" } ] }, "/ix-facilities/{ixfacilityID}/facility": { "summary": "Get a ixfacilities associated facility", "description": "Get a ixfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxFacilities", "Facilities" ], "summary": "Get a ixfacilities associated facility", "description": "Get a ixfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxFacilityFacility", "responses": { "200": { "description": "The requested facility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxFacilityID" } ] }, "/ix-facilities/{ixfacilityID}/internet-exchange": { "summary": "Get a ixfacilities associated internetExchange", "description": "Get a ixfacilities associated internetExchange (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxFacilities", "InternetExchanges" ], "summary": "Get a ixfacilities associated internetExchange", "description": "Get a ixfacilities associated internetExchange (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxFacilityInternetExchange", "responses": { "200": { "description": "The requested internetExchange entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxFacilityID" } ] }, "/ix-lans": { "summary": "List ixlans", "description": "List IxLan entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxLans" ], "summary": "List ixlans", "description": "List IxLan entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listIxLans", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxLanSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxLanIxIDEQ" }, { "$ref": "#/components/parameters/IxLanIxIDNEQ" }, { "$ref": "#/components/parameters/IxLanIxIDIn" }, { "$ref": "#/components/parameters/IxLanIxIDNotIn" }, { "$ref": "#/components/parameters/IxLanNameEQ" }, { "$ref": "#/components/parameters/IxLanNameNEQ" }, { "$ref": "#/components/parameters/IxLanNameIsNil" }, { "$ref": "#/components/parameters/IxLanNameIn" }, { "$ref": "#/components/parameters/IxLanNameNotIn" }, { "$ref": "#/components/parameters/IxLanNameEqualFold" }, { "$ref": "#/components/parameters/IxLanNameContains" }, { "$ref": "#/components/parameters/IxLanNameContainsFold" }, { "$ref": "#/components/parameters/IxLanNameHasPrefix" }, { "$ref": "#/components/parameters/IxLanNameHasSuffix" }, { "$ref": "#/components/parameters/IxLanCreatedGT" }, { "$ref": "#/components/parameters/IxLanCreatedGTE" }, { "$ref": "#/components/parameters/IxLanCreatedLT" }, { "$ref": "#/components/parameters/IxLanCreatedLTE" }, { "$ref": "#/components/parameters/IxLanUpdatedGT" }, { "$ref": "#/components/parameters/IxLanUpdatedGTE" }, { "$ref": "#/components/parameters/IxLanUpdatedLT" }, { "$ref": "#/components/parameters/IxLanUpdatedLTE" }, { "$ref": "#/components/parameters/IxLanStatusEQ" }, { "$ref": "#/components/parameters/IxLanStatusNEQ" }, { "$ref": "#/components/parameters/IxLanStatusIn" }, { "$ref": "#/components/parameters/IxLanStatusNotIn" }, { "$ref": "#/components/parameters/IxLanStatusEqualFold" }, { "$ref": "#/components/parameters/IxLanStatusContains" }, { "$ref": "#/components/parameters/IxLanStatusContainsFold" }, { "$ref": "#/components/parameters/IxLanStatusHasPrefix" }, { "$ref": "#/components/parameters/IxLanStatusHasSuffix" } ], "responses": { "200": { "description": "The requested IxLan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/ix-lans/{ixlanID}": { "summary": "Operate on a single IxLan entity", "description": "Operate on a single IxLan entity by its ID.", "get": { "tags": [ "IxLans" ], "summary": "Retrieve a ixlan", "description": "Retrieve a single IxLan entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxLan", "responses": { "200": { "description": "The requested IxLan entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxLanID" } ] }, "/ix-lans/{ixlanID}/internet-exchange": { "summary": "Get a ixlans associated internetExchange", "description": "Get a ixlans associated internetExchange (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxLans", "InternetExchanges" ], "summary": "Get a ixlans associated internetExchange", "description": "Get a ixlans associated internetExchange (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxLanInternetExchange", "responses": { "200": { "description": "The requested internetExchange entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternetExchangeRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxLanID" } ] }, "/ix-lans/{ixlanID}/ix-prefixes": { "summary": "List a ixlans associated ixPrefixes", "description": "List a ixlans associated ixPrefixes (IxPrefix entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxLans", "IxPrefixes" ], "summary": "List a ixlans associated ixPrefixes", "description": "List a ixlans associated ixPrefixes (IxPrefix entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listIxLanIxPrefixes", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxPrefixSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDEQ" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDNEQ" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDIn" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDNotIn" }, { "$ref": "#/components/parameters/IxPrefixCreatedGT" }, { "$ref": "#/components/parameters/IxPrefixCreatedGTE" }, { "$ref": "#/components/parameters/IxPrefixCreatedLT" }, { "$ref": "#/components/parameters/IxPrefixCreatedLTE" }, { "$ref": "#/components/parameters/IxPrefixUpdatedGT" }, { "$ref": "#/components/parameters/IxPrefixUpdatedGTE" }, { "$ref": "#/components/parameters/IxPrefixUpdatedLT" }, { "$ref": "#/components/parameters/IxPrefixUpdatedLTE" }, { "$ref": "#/components/parameters/IxPrefixStatusEQ" }, { "$ref": "#/components/parameters/IxPrefixStatusNEQ" }, { "$ref": "#/components/parameters/IxPrefixStatusIn" }, { "$ref": "#/components/parameters/IxPrefixStatusNotIn" }, { "$ref": "#/components/parameters/IxPrefixStatusEqualFold" }, { "$ref": "#/components/parameters/IxPrefixStatusContains" }, { "$ref": "#/components/parameters/IxPrefixStatusContainsFold" }, { "$ref": "#/components/parameters/IxPrefixStatusHasPrefix" }, { "$ref": "#/components/parameters/IxPrefixStatusHasSuffix" } ], "responses": { "200": { "description": "The requested ixPrefixes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanIxPrefixList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxLanID" } ] }, "/ix-lans/{ixlanID}/network-ix-lans": { "summary": "List a ixlans associated networkIxLans", "description": "List a ixlans associated networkIxLans (NetworkIxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxLans", "NetworkIxLans" ], "summary": "List a ixlans associated networkIxLans", "description": "List a ixlans associated networkIxLans (NetworkIxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listIxLanNetworkIxLans", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkIxLanSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameIsNil" }, { "$ref": "#/components/parameters/NetworkIxLanNameIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameContains" }, { "$ref": "#/components/parameters/NetworkIxLanNameContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContains" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasSuffix" } ], "responses": { "200": { "description": "The requested networkIxLans.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanNetworkIxLanList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxLanID" } ] }, "/ix-prefixes": { "summary": "List ixprefixes", "description": "List IxPrefix entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxPrefixes" ], "summary": "List ixprefixes", "description": "List IxPrefix entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listIxPrefixes", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/IxPrefixSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDEQ" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDNEQ" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDIn" }, { "$ref": "#/components/parameters/IxPrefixIxlanIDNotIn" }, { "$ref": "#/components/parameters/IxPrefixCreatedGT" }, { "$ref": "#/components/parameters/IxPrefixCreatedGTE" }, { "$ref": "#/components/parameters/IxPrefixCreatedLT" }, { "$ref": "#/components/parameters/IxPrefixCreatedLTE" }, { "$ref": "#/components/parameters/IxPrefixUpdatedGT" }, { "$ref": "#/components/parameters/IxPrefixUpdatedGTE" }, { "$ref": "#/components/parameters/IxPrefixUpdatedLT" }, { "$ref": "#/components/parameters/IxPrefixUpdatedLTE" }, { "$ref": "#/components/parameters/IxPrefixStatusEQ" }, { "$ref": "#/components/parameters/IxPrefixStatusNEQ" }, { "$ref": "#/components/parameters/IxPrefixStatusIn" }, { "$ref": "#/components/parameters/IxPrefixStatusNotIn" }, { "$ref": "#/components/parameters/IxPrefixStatusEqualFold" }, { "$ref": "#/components/parameters/IxPrefixStatusContains" }, { "$ref": "#/components/parameters/IxPrefixStatusContainsFold" }, { "$ref": "#/components/parameters/IxPrefixStatusHasPrefix" }, { "$ref": "#/components/parameters/IxPrefixStatusHasSuffix" } ], "responses": { "200": { "description": "The requested IxPrefix.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxPrefixList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/ix-prefixes/{ixprefixID}": { "summary": "Operate on a single IxPrefix entity", "description": "Operate on a single IxPrefix entity by its ID.", "get": { "tags": [ "IxPrefixes" ], "summary": "Retrieve a ixprefix", "description": "Retrieve a single IxPrefix entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxPrefix", "responses": { "200": { "description": "The requested IxPrefix entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxPrefixRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxPrefixID" } ] }, "/ix-prefixes/{ixprefixID}/ix-lan": { "summary": "Get a ixprefixes associated ixLan", "description": "Get a ixprefixes associated ixLan (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "IxPrefixes", "IxLans" ], "summary": "Get a ixprefixes associated ixLan", "description": "Get a ixprefixes associated ixLan (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getIxPrefixIxLan", "responses": { "200": { "description": "The requested ixLan entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/IxPrefixID" } ] }, "/network-facilities": { "summary": "List networkfacilities", "description": "List NetworkFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkFacilities" ], "summary": "List networkfacilities", "description": "List NetworkFacility entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworkFacilities", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityNameIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameContains" }, { "$ref": "#/components/parameters/NetworkFacilityNameContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCityEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCityIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityContains" }, { "$ref": "#/components/parameters/NetworkFacilityCityContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContains" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContains" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested NetworkFacility.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/network-facilities/{networkfacilityID}": { "summary": "Operate on a single NetworkFacility entity", "description": "Operate on a single NetworkFacility entity by its ID.", "get": { "tags": [ "NetworkFacilities" ], "summary": "Retrieve a networkfacility", "description": "Retrieve a single NetworkFacility entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkFacility", "responses": { "200": { "description": "The requested NetworkFacility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkFacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkFacilityID" } ] }, "/network-facilities/{networkfacilityID}/facility": { "summary": "Get a networkfacilities associated facility", "description": "Get a networkfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkFacilities", "Facilities" ], "summary": "Get a networkfacilities associated facility", "description": "Get a networkfacilities associated facility (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkFacilityFacility", "responses": { "200": { "description": "The requested facility entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacilityRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkFacilityID" } ] }, "/network-facilities/{networkfacilityID}/network": { "summary": "Get a networkfacilities associated network", "description": "Get a networkfacilities associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkFacilities", "Networks" ], "summary": "Get a networkfacilities associated network", "description": "Get a networkfacilities associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkFacilityNetwork", "responses": { "200": { "description": "The requested network entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkFacilityID" } ] }, "/network-ix-lans": { "summary": "List networkixlans", "description": "List NetworkIxLan entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkIxLans" ], "summary": "List networkixlans", "description": "List NetworkIxLan entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworkIxLans", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkIxLanSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameIsNil" }, { "$ref": "#/components/parameters/NetworkIxLanNameIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameContains" }, { "$ref": "#/components/parameters/NetworkIxLanNameContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContains" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasSuffix" } ], "responses": { "200": { "description": "The requested NetworkIxLan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkIxLanList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/network-ix-lans/{networkixlanID}": { "summary": "Operate on a single NetworkIxLan entity", "description": "Operate on a single NetworkIxLan entity by its ID.", "get": { "tags": [ "NetworkIxLans" ], "summary": "Retrieve a networkixlan", "description": "Retrieve a single NetworkIxLan entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkIxLan", "responses": { "200": { "description": "The requested NetworkIxLan entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkIxLanRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkIxLanID" } ] }, "/network-ix-lans/{networkixlanID}/ix-lan": { "summary": "Get a networkixlans associated ixLan", "description": "Get a networkixlans associated ixLan (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkIxLans", "IxLans" ], "summary": "Get a networkixlans associated ixLan", "description": "Get a networkixlans associated ixLan (IxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkIxLanIxLan", "responses": { "200": { "description": "The requested ixLan entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IxLanRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkIxLanID" } ] }, "/network-ix-lans/{networkixlanID}/network": { "summary": "Get a networkixlans associated network", "description": "Get a networkixlans associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "NetworkIxLans", "Networks" ], "summary": "Get a networkixlans associated network", "description": "Get a networkixlans associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkIxLanNetwork", "responses": { "200": { "description": "The requested network entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkIxLanID" } ] }, "/networks": { "summary": "List networks", "description": "List Network entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Networks" ], "summary": "List networks", "description": "List Network entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworks", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkOrgIDEQ" }, { "$ref": "#/components/parameters/NetworkOrgIDNEQ" }, { "$ref": "#/components/parameters/NetworkOrgIDIn" }, { "$ref": "#/components/parameters/NetworkOrgIDNotIn" }, { "$ref": "#/components/parameters/NetworkAkaEQ" }, { "$ref": "#/components/parameters/NetworkAkaNEQ" }, { "$ref": "#/components/parameters/NetworkAkaIsNil" }, { "$ref": "#/components/parameters/NetworkAkaIn" }, { "$ref": "#/components/parameters/NetworkAkaNotIn" }, { "$ref": "#/components/parameters/NetworkAkaEqualFold" }, { "$ref": "#/components/parameters/NetworkAkaContains" }, { "$ref": "#/components/parameters/NetworkAkaContainsFold" }, { "$ref": "#/components/parameters/NetworkAkaHasPrefix" }, { "$ref": "#/components/parameters/NetworkAkaHasSuffix" }, { "$ref": "#/components/parameters/NetworkAsnEQ" }, { "$ref": "#/components/parameters/NetworkAsnNEQ" }, { "$ref": "#/components/parameters/NetworkAsnGT" }, { "$ref": "#/components/parameters/NetworkAsnGTE" }, { "$ref": "#/components/parameters/NetworkAsnLT" }, { "$ref": "#/components/parameters/NetworkAsnLTE" }, { "$ref": "#/components/parameters/NetworkAsnIn" }, { "$ref": "#/components/parameters/NetworkAsnNotIn" }, { "$ref": "#/components/parameters/NetworkNameEQ" }, { "$ref": "#/components/parameters/NetworkNameNEQ" }, { "$ref": "#/components/parameters/NetworkNameIn" }, { "$ref": "#/components/parameters/NetworkNameNotIn" }, { "$ref": "#/components/parameters/NetworkNameEqualFold" }, { "$ref": "#/components/parameters/NetworkNameContains" }, { "$ref": "#/components/parameters/NetworkNameContainsFold" }, { "$ref": "#/components/parameters/NetworkNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkNameLongEQ" }, { "$ref": "#/components/parameters/NetworkNameLongNEQ" }, { "$ref": "#/components/parameters/NetworkNameLongIsNil" }, { "$ref": "#/components/parameters/NetworkNameLongIn" }, { "$ref": "#/components/parameters/NetworkNameLongNotIn" }, { "$ref": "#/components/parameters/NetworkNameLongEqualFold" }, { "$ref": "#/components/parameters/NetworkNameLongContains" }, { "$ref": "#/components/parameters/NetworkNameLongContainsFold" }, { "$ref": "#/components/parameters/NetworkNameLongHasPrefix" }, { "$ref": "#/components/parameters/NetworkNameLongHasSuffix" }, { "$ref": "#/components/parameters/NetworkCreatedGT" }, { "$ref": "#/components/parameters/NetworkCreatedGTE" }, { "$ref": "#/components/parameters/NetworkCreatedLT" }, { "$ref": "#/components/parameters/NetworkCreatedLTE" }, { "$ref": "#/components/parameters/NetworkUpdatedGT" }, { "$ref": "#/components/parameters/NetworkUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkUpdatedLT" }, { "$ref": "#/components/parameters/NetworkUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkStatusEQ" }, { "$ref": "#/components/parameters/NetworkStatusNEQ" }, { "$ref": "#/components/parameters/NetworkStatusIn" }, { "$ref": "#/components/parameters/NetworkStatusNotIn" }, { "$ref": "#/components/parameters/NetworkStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkStatusContains" }, { "$ref": "#/components/parameters/NetworkStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Network.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/networks/{networkID}": { "summary": "Operate on a single Network entity", "description": "Operate on a single Network entity by its ID.", "get": { "tags": [ "Networks" ], "summary": "Retrieve a network", "description": "Retrieve a single Network entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetwork", "responses": { "200": { "description": "The requested Network entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkID" } ] }, "/networks/{networkID}/network-facilities": { "summary": "List a networks associated networkFacilities", "description": "List a networks associated networkFacilities (NetworkFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Networks", "NetworkFacilities" ], "summary": "List a networks associated networkFacilities", "description": "List a networks associated networkFacilities (NetworkFacility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworkNetworkFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkFacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityFacIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDIn" }, { "$ref": "#/components/parameters/NetworkFacilityNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityNameIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityNameIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityNameEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameContains" }, { "$ref": "#/components/parameters/NetworkFacilityNameContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCityEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCityIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCityIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCityEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityContains" }, { "$ref": "#/components/parameters/NetworkFacilityCityContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCityHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIsNil" }, { "$ref": "#/components/parameters/NetworkFacilityCountryIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityCountryEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContains" }, { "$ref": "#/components/parameters/NetworkFacilityCountryContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityCreatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLT" }, { "$ref": "#/components/parameters/NetworkFacilityUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNEQ" }, { "$ref": "#/components/parameters/NetworkFacilityStatusIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusNotIn" }, { "$ref": "#/components/parameters/NetworkFacilityStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContains" }, { "$ref": "#/components/parameters/NetworkFacilityStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkFacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested networkFacilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNetworkFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkID" } ] }, "/networks/{networkID}/network-ix-lans": { "summary": "List a networks associated networkIxLans", "description": "List a networks associated networkIxLans (NetworkIxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Networks", "NetworkIxLans" ], "summary": "List a networks associated networkIxLans", "description": "List a networks associated networkIxLans (NetworkIxLan entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworkNetworkIxLans", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkIxLanSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanIxlanIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDGTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLT" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDLTE" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDIn" }, { "$ref": "#/components/parameters/NetworkIxLanNetSideIDNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnGTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLT" }, { "$ref": "#/components/parameters/NetworkIxLanAsnLTE" }, { "$ref": "#/components/parameters/NetworkIxLanAsnIn" }, { "$ref": "#/components/parameters/NetworkIxLanAsnNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanNameIsNil" }, { "$ref": "#/components/parameters/NetworkIxLanNameIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanNameEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameContains" }, { "$ref": "#/components/parameters/NetworkIxLanNameContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanCreatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLT" }, { "$ref": "#/components/parameters/NetworkIxLanUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNEQ" }, { "$ref": "#/components/parameters/NetworkIxLanStatusIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusNotIn" }, { "$ref": "#/components/parameters/NetworkIxLanStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContains" }, { "$ref": "#/components/parameters/NetworkIxLanStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkIxLanStatusHasSuffix" } ], "responses": { "200": { "description": "The requested networkIxLans.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNetworkIxLanList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkID" } ] }, "/networks/{networkID}/organization": { "summary": "Get a networks associated organization", "description": "Get a networks associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Networks", "Organizations" ], "summary": "Get a networks associated organization", "description": "Get a networks associated organization (Organization entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getNetworkOrganization", "responses": { "200": { "description": "The requested organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkID" } ] }, "/networks/{networkID}/pocs": { "summary": "List a networks associated pocs", "description": "List a networks associated pocs (Poc entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Networks", "Pocs" ], "summary": "List a networks associated pocs", "description": "List a networks associated pocs (Poc entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listNetworkPocs", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/PocSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/PocNetIDEQ" }, { "$ref": "#/components/parameters/PocNetIDNEQ" }, { "$ref": "#/components/parameters/PocNetIDIn" }, { "$ref": "#/components/parameters/PocNetIDNotIn" }, { "$ref": "#/components/parameters/PocEmailEQ" }, { "$ref": "#/components/parameters/PocEmailNEQ" }, { "$ref": "#/components/parameters/PocEmailIsNil" }, { "$ref": "#/components/parameters/PocEmailIn" }, { "$ref": "#/components/parameters/PocEmailNotIn" }, { "$ref": "#/components/parameters/PocEmailEqualFold" }, { "$ref": "#/components/parameters/PocEmailContains" }, { "$ref": "#/components/parameters/PocEmailContainsFold" }, { "$ref": "#/components/parameters/PocEmailHasPrefix" }, { "$ref": "#/components/parameters/PocEmailHasSuffix" }, { "$ref": "#/components/parameters/PocNameEQ" }, { "$ref": "#/components/parameters/PocNameNEQ" }, { "$ref": "#/components/parameters/PocNameIsNil" }, { "$ref": "#/components/parameters/PocNameIn" }, { "$ref": "#/components/parameters/PocNameNotIn" }, { "$ref": "#/components/parameters/PocNameEqualFold" }, { "$ref": "#/components/parameters/PocNameContains" }, { "$ref": "#/components/parameters/PocNameContainsFold" }, { "$ref": "#/components/parameters/PocNameHasPrefix" }, { "$ref": "#/components/parameters/PocNameHasSuffix" }, { "$ref": "#/components/parameters/PocRoleEQ" }, { "$ref": "#/components/parameters/PocRoleNEQ" }, { "$ref": "#/components/parameters/PocRoleIn" }, { "$ref": "#/components/parameters/PocRoleNotIn" }, { "$ref": "#/components/parameters/PocRoleEqualFold" }, { "$ref": "#/components/parameters/PocRoleContains" }, { "$ref": "#/components/parameters/PocRoleContainsFold" }, { "$ref": "#/components/parameters/PocRoleHasPrefix" }, { "$ref": "#/components/parameters/PocRoleHasSuffix" }, { "$ref": "#/components/parameters/PocVisibleEQ" }, { "$ref": "#/components/parameters/PocVisibleNEQ" }, { "$ref": "#/components/parameters/PocVisibleIsNil" }, { "$ref": "#/components/parameters/PocVisibleIn" }, { "$ref": "#/components/parameters/PocVisibleNotIn" }, { "$ref": "#/components/parameters/PocVisibleEqualFold" }, { "$ref": "#/components/parameters/PocVisibleContains" }, { "$ref": "#/components/parameters/PocVisibleContainsFold" }, { "$ref": "#/components/parameters/PocVisibleHasPrefix" }, { "$ref": "#/components/parameters/PocVisibleHasSuffix" }, { "$ref": "#/components/parameters/PocCreatedGT" }, { "$ref": "#/components/parameters/PocCreatedGTE" }, { "$ref": "#/components/parameters/PocCreatedLT" }, { "$ref": "#/components/parameters/PocCreatedLTE" }, { "$ref": "#/components/parameters/PocUpdatedGT" }, { "$ref": "#/components/parameters/PocUpdatedGTE" }, { "$ref": "#/components/parameters/PocUpdatedLT" }, { "$ref": "#/components/parameters/PocUpdatedLTE" }, { "$ref": "#/components/parameters/PocStatusEQ" }, { "$ref": "#/components/parameters/PocStatusNEQ" }, { "$ref": "#/components/parameters/PocStatusIn" }, { "$ref": "#/components/parameters/PocStatusNotIn" }, { "$ref": "#/components/parameters/PocStatusEqualFold" }, { "$ref": "#/components/parameters/PocStatusContains" }, { "$ref": "#/components/parameters/PocStatusContainsFold" }, { "$ref": "#/components/parameters/PocStatusHasPrefix" }, { "$ref": "#/components/parameters/PocStatusHasSuffix" } ], "responses": { "200": { "description": "The requested pocs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPocList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/NetworkID" } ] }, "/openapi.json": { "get": { "tags": [ "Meta" ], "summary": "Get OpenAPI spec", "description": "Get the OpenAPI specification for this service.", "operationId": "getOpenAPI", "responses": { "200": { "description": "OpenAPI specification was found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } } }, "/organizations": { "summary": "List organizations", "description": "List Organization entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations" ], "summary": "List organizations", "description": "List Organization entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizations", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/OrganizationSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/OrganizationAkaEQ" }, { "$ref": "#/components/parameters/OrganizationAkaNEQ" }, { "$ref": "#/components/parameters/OrganizationAkaIsNil" }, { "$ref": "#/components/parameters/OrganizationAkaIn" }, { "$ref": "#/components/parameters/OrganizationAkaNotIn" }, { "$ref": "#/components/parameters/OrganizationAkaEqualFold" }, { "$ref": "#/components/parameters/OrganizationAkaContains" }, { "$ref": "#/components/parameters/OrganizationAkaContainsFold" }, { "$ref": "#/components/parameters/OrganizationAkaHasPrefix" }, { "$ref": "#/components/parameters/OrganizationAkaHasSuffix" }, { "$ref": "#/components/parameters/OrganizationCityEQ" }, { "$ref": "#/components/parameters/OrganizationCityNEQ" }, { "$ref": "#/components/parameters/OrganizationCityIsNil" }, { "$ref": "#/components/parameters/OrganizationCityIn" }, { "$ref": "#/components/parameters/OrganizationCityNotIn" }, { "$ref": "#/components/parameters/OrganizationCityEqualFold" }, { "$ref": "#/components/parameters/OrganizationCityContains" }, { "$ref": "#/components/parameters/OrganizationCityContainsFold" }, { "$ref": "#/components/parameters/OrganizationCityHasPrefix" }, { "$ref": "#/components/parameters/OrganizationCityHasSuffix" }, { "$ref": "#/components/parameters/OrganizationCountryEQ" }, { "$ref": "#/components/parameters/OrganizationCountryNEQ" }, { "$ref": "#/components/parameters/OrganizationCountryIsNil" }, { "$ref": "#/components/parameters/OrganizationCountryIn" }, { "$ref": "#/components/parameters/OrganizationCountryNotIn" }, { "$ref": "#/components/parameters/OrganizationCountryEqualFold" }, { "$ref": "#/components/parameters/OrganizationCountryContains" }, { "$ref": "#/components/parameters/OrganizationCountryContainsFold" }, { "$ref": "#/components/parameters/OrganizationCountryHasPrefix" }, { "$ref": "#/components/parameters/OrganizationCountryHasSuffix" }, { "$ref": "#/components/parameters/OrganizationNameEQ" }, { "$ref": "#/components/parameters/OrganizationNameNEQ" }, { "$ref": "#/components/parameters/OrganizationNameIn" }, { "$ref": "#/components/parameters/OrganizationNameNotIn" }, { "$ref": "#/components/parameters/OrganizationNameEqualFold" }, { "$ref": "#/components/parameters/OrganizationNameContains" }, { "$ref": "#/components/parameters/OrganizationNameContainsFold" }, { "$ref": "#/components/parameters/OrganizationNameHasPrefix" }, { "$ref": "#/components/parameters/OrganizationNameHasSuffix" }, { "$ref": "#/components/parameters/OrganizationNameLongEQ" }, { "$ref": "#/components/parameters/OrganizationNameLongNEQ" }, { "$ref": "#/components/parameters/OrganizationNameLongIsNil" }, { "$ref": "#/components/parameters/OrganizationNameLongIn" }, { "$ref": "#/components/parameters/OrganizationNameLongNotIn" }, { "$ref": "#/components/parameters/OrganizationNameLongEqualFold" }, { "$ref": "#/components/parameters/OrganizationNameLongContains" }, { "$ref": "#/components/parameters/OrganizationNameLongContainsFold" }, { "$ref": "#/components/parameters/OrganizationNameLongHasPrefix" }, { "$ref": "#/components/parameters/OrganizationNameLongHasSuffix" }, { "$ref": "#/components/parameters/OrganizationStateEQ" }, { "$ref": "#/components/parameters/OrganizationStateNEQ" }, { "$ref": "#/components/parameters/OrganizationStateIsNil" }, { "$ref": "#/components/parameters/OrganizationStateIn" }, { "$ref": "#/components/parameters/OrganizationStateNotIn" }, { "$ref": "#/components/parameters/OrganizationStateEqualFold" }, { "$ref": "#/components/parameters/OrganizationStateContains" }, { "$ref": "#/components/parameters/OrganizationStateContainsFold" }, { "$ref": "#/components/parameters/OrganizationStateHasPrefix" }, { "$ref": "#/components/parameters/OrganizationStateHasSuffix" }, { "$ref": "#/components/parameters/OrganizationCreatedGT" }, { "$ref": "#/components/parameters/OrganizationCreatedGTE" }, { "$ref": "#/components/parameters/OrganizationCreatedLT" }, { "$ref": "#/components/parameters/OrganizationCreatedLTE" }, { "$ref": "#/components/parameters/OrganizationUpdatedGT" }, { "$ref": "#/components/parameters/OrganizationUpdatedGTE" }, { "$ref": "#/components/parameters/OrganizationUpdatedLT" }, { "$ref": "#/components/parameters/OrganizationUpdatedLTE" }, { "$ref": "#/components/parameters/OrganizationStatusEQ" }, { "$ref": "#/components/parameters/OrganizationStatusNEQ" }, { "$ref": "#/components/parameters/OrganizationStatusIn" }, { "$ref": "#/components/parameters/OrganizationStatusNotIn" }, { "$ref": "#/components/parameters/OrganizationStatusEqualFold" }, { "$ref": "#/components/parameters/OrganizationStatusContains" }, { "$ref": "#/components/parameters/OrganizationStatusContainsFold" }, { "$ref": "#/components/parameters/OrganizationStatusHasPrefix" }, { "$ref": "#/components/parameters/OrganizationStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/organizations/{organizationID}": { "summary": "Operate on a single Organization entity", "description": "Operate on a single Organization entity by its ID.", "get": { "tags": [ "Organizations" ], "summary": "Retrieve a organization", "description": "Retrieve a single Organization entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getOrganization", "responses": { "200": { "description": "The requested Organization entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/organizations/{organizationID}/campuses": { "summary": "List a organizations associated campuses", "description": "List a organizations associated campuses (Campus entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations", "Campus" ], "summary": "List a organizations associated campuses", "description": "List a organizations associated campuses (Campus entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizationCampuses", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CampusSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CampusOrgIDEQ" }, { "$ref": "#/components/parameters/CampusOrgIDNEQ" }, { "$ref": "#/components/parameters/CampusOrgIDIn" }, { "$ref": "#/components/parameters/CampusOrgIDNotIn" }, { "$ref": "#/components/parameters/CampusAkaEQ" }, { "$ref": "#/components/parameters/CampusAkaNEQ" }, { "$ref": "#/components/parameters/CampusAkaIsNil" }, { "$ref": "#/components/parameters/CampusAkaIn" }, { "$ref": "#/components/parameters/CampusAkaNotIn" }, { "$ref": "#/components/parameters/CampusAkaEqualFold" }, { "$ref": "#/components/parameters/CampusAkaContains" }, { "$ref": "#/components/parameters/CampusAkaContainsFold" }, { "$ref": "#/components/parameters/CampusAkaHasPrefix" }, { "$ref": "#/components/parameters/CampusAkaHasSuffix" }, { "$ref": "#/components/parameters/CampusCityEQ" }, { "$ref": "#/components/parameters/CampusCityNEQ" }, { "$ref": "#/components/parameters/CampusCityIsNil" }, { "$ref": "#/components/parameters/CampusCityIn" }, { "$ref": "#/components/parameters/CampusCityNotIn" }, { "$ref": "#/components/parameters/CampusCityEqualFold" }, { "$ref": "#/components/parameters/CampusCityContains" }, { "$ref": "#/components/parameters/CampusCityContainsFold" }, { "$ref": "#/components/parameters/CampusCityHasPrefix" }, { "$ref": "#/components/parameters/CampusCityHasSuffix" }, { "$ref": "#/components/parameters/CampusCountryEQ" }, { "$ref": "#/components/parameters/CampusCountryNEQ" }, { "$ref": "#/components/parameters/CampusCountryIsNil" }, { "$ref": "#/components/parameters/CampusCountryIn" }, { "$ref": "#/components/parameters/CampusCountryNotIn" }, { "$ref": "#/components/parameters/CampusCountryEqualFold" }, { "$ref": "#/components/parameters/CampusCountryContains" }, { "$ref": "#/components/parameters/CampusCountryContainsFold" }, { "$ref": "#/components/parameters/CampusCountryHasPrefix" }, { "$ref": "#/components/parameters/CampusCountryHasSuffix" }, { "$ref": "#/components/parameters/CampusNameEQ" }, { "$ref": "#/components/parameters/CampusNameNEQ" }, { "$ref": "#/components/parameters/CampusNameIn" }, { "$ref": "#/components/parameters/CampusNameNotIn" }, { "$ref": "#/components/parameters/CampusNameEqualFold" }, { "$ref": "#/components/parameters/CampusNameContains" }, { "$ref": "#/components/parameters/CampusNameContainsFold" }, { "$ref": "#/components/parameters/CampusNameHasPrefix" }, { "$ref": "#/components/parameters/CampusNameHasSuffix" }, { "$ref": "#/components/parameters/CampusNameLongEQ" }, { "$ref": "#/components/parameters/CampusNameLongNEQ" }, { "$ref": "#/components/parameters/CampusNameLongIsNil" }, { "$ref": "#/components/parameters/CampusNameLongIn" }, { "$ref": "#/components/parameters/CampusNameLongNotIn" }, { "$ref": "#/components/parameters/CampusNameLongEqualFold" }, { "$ref": "#/components/parameters/CampusNameLongContains" }, { "$ref": "#/components/parameters/CampusNameLongContainsFold" }, { "$ref": "#/components/parameters/CampusNameLongHasPrefix" }, { "$ref": "#/components/parameters/CampusNameLongHasSuffix" }, { "$ref": "#/components/parameters/CampusStateEQ" }, { "$ref": "#/components/parameters/CampusStateNEQ" }, { "$ref": "#/components/parameters/CampusStateIsNil" }, { "$ref": "#/components/parameters/CampusStateIn" }, { "$ref": "#/components/parameters/CampusStateNotIn" }, { "$ref": "#/components/parameters/CampusStateEqualFold" }, { "$ref": "#/components/parameters/CampusStateContains" }, { "$ref": "#/components/parameters/CampusStateContainsFold" }, { "$ref": "#/components/parameters/CampusStateHasPrefix" }, { "$ref": "#/components/parameters/CampusStateHasSuffix" }, { "$ref": "#/components/parameters/CampusCreatedGT" }, { "$ref": "#/components/parameters/CampusCreatedGTE" }, { "$ref": "#/components/parameters/CampusCreatedLT" }, { "$ref": "#/components/parameters/CampusCreatedLTE" }, { "$ref": "#/components/parameters/CampusUpdatedGT" }, { "$ref": "#/components/parameters/CampusUpdatedGTE" }, { "$ref": "#/components/parameters/CampusUpdatedLT" }, { "$ref": "#/components/parameters/CampusUpdatedLTE" }, { "$ref": "#/components/parameters/CampusStatusEQ" }, { "$ref": "#/components/parameters/CampusStatusNEQ" }, { "$ref": "#/components/parameters/CampusStatusIn" }, { "$ref": "#/components/parameters/CampusStatusNotIn" }, { "$ref": "#/components/parameters/CampusStatusEqualFold" }, { "$ref": "#/components/parameters/CampusStatusContains" }, { "$ref": "#/components/parameters/CampusStatusContainsFold" }, { "$ref": "#/components/parameters/CampusStatusHasPrefix" }, { "$ref": "#/components/parameters/CampusStatusHasSuffix" } ], "responses": { "200": { "description": "The requested campuses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCampusList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/organizations/{organizationID}/carriers": { "summary": "List a organizations associated carriers", "description": "List a organizations associated carriers (Carrier entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations", "Carriers" ], "summary": "List a organizations associated carriers", "description": "List a organizations associated carriers (Carrier entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizationCarriers", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/CarrierSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/CarrierOrgIDEQ" }, { "$ref": "#/components/parameters/CarrierOrgIDNEQ" }, { "$ref": "#/components/parameters/CarrierOrgIDIn" }, { "$ref": "#/components/parameters/CarrierOrgIDNotIn" }, { "$ref": "#/components/parameters/CarrierAkaEQ" }, { "$ref": "#/components/parameters/CarrierAkaNEQ" }, { "$ref": "#/components/parameters/CarrierAkaIsNil" }, { "$ref": "#/components/parameters/CarrierAkaIn" }, { "$ref": "#/components/parameters/CarrierAkaNotIn" }, { "$ref": "#/components/parameters/CarrierAkaEqualFold" }, { "$ref": "#/components/parameters/CarrierAkaContains" }, { "$ref": "#/components/parameters/CarrierAkaContainsFold" }, { "$ref": "#/components/parameters/CarrierAkaHasPrefix" }, { "$ref": "#/components/parameters/CarrierAkaHasSuffix" }, { "$ref": "#/components/parameters/CarrierNameEQ" }, { "$ref": "#/components/parameters/CarrierNameNEQ" }, { "$ref": "#/components/parameters/CarrierNameIn" }, { "$ref": "#/components/parameters/CarrierNameNotIn" }, { "$ref": "#/components/parameters/CarrierNameEqualFold" }, { "$ref": "#/components/parameters/CarrierNameContains" }, { "$ref": "#/components/parameters/CarrierNameContainsFold" }, { "$ref": "#/components/parameters/CarrierNameHasPrefix" }, { "$ref": "#/components/parameters/CarrierNameHasSuffix" }, { "$ref": "#/components/parameters/CarrierNameLongEQ" }, { "$ref": "#/components/parameters/CarrierNameLongNEQ" }, { "$ref": "#/components/parameters/CarrierNameLongIsNil" }, { "$ref": "#/components/parameters/CarrierNameLongIn" }, { "$ref": "#/components/parameters/CarrierNameLongNotIn" }, { "$ref": "#/components/parameters/CarrierNameLongEqualFold" }, { "$ref": "#/components/parameters/CarrierNameLongContains" }, { "$ref": "#/components/parameters/CarrierNameLongContainsFold" }, { "$ref": "#/components/parameters/CarrierNameLongHasPrefix" }, { "$ref": "#/components/parameters/CarrierNameLongHasSuffix" }, { "$ref": "#/components/parameters/CarrierCreatedGT" }, { "$ref": "#/components/parameters/CarrierCreatedGTE" }, { "$ref": "#/components/parameters/CarrierCreatedLT" }, { "$ref": "#/components/parameters/CarrierCreatedLTE" }, { "$ref": "#/components/parameters/CarrierUpdatedGT" }, { "$ref": "#/components/parameters/CarrierUpdatedGTE" }, { "$ref": "#/components/parameters/CarrierUpdatedLT" }, { "$ref": "#/components/parameters/CarrierUpdatedLTE" }, { "$ref": "#/components/parameters/CarrierStatusEQ" }, { "$ref": "#/components/parameters/CarrierStatusNEQ" }, { "$ref": "#/components/parameters/CarrierStatusIn" }, { "$ref": "#/components/parameters/CarrierStatusNotIn" }, { "$ref": "#/components/parameters/CarrierStatusEqualFold" }, { "$ref": "#/components/parameters/CarrierStatusContains" }, { "$ref": "#/components/parameters/CarrierStatusContainsFold" }, { "$ref": "#/components/parameters/CarrierStatusHasPrefix" }, { "$ref": "#/components/parameters/CarrierStatusHasSuffix" } ], "responses": { "200": { "description": "The requested carriers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCarrierList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/organizations/{organizationID}/facilities": { "summary": "List a organizations associated facilities", "description": "List a organizations associated facilities (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations", "Facilities" ], "summary": "List a organizations associated facilities", "description": "List a organizations associated facilities (Facility entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizationFacilities", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/FacilitySortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/FacilityCampusIDEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDNEQ" }, { "$ref": "#/components/parameters/FacilityCampusIDIn" }, { "$ref": "#/components/parameters/FacilityCampusIDNotIn" }, { "$ref": "#/components/parameters/FacilityOrgIDEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDNEQ" }, { "$ref": "#/components/parameters/FacilityOrgIDIn" }, { "$ref": "#/components/parameters/FacilityOrgIDNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEQ" }, { "$ref": "#/components/parameters/FacilityAkaNEQ" }, { "$ref": "#/components/parameters/FacilityAkaIsNil" }, { "$ref": "#/components/parameters/FacilityAkaIn" }, { "$ref": "#/components/parameters/FacilityAkaNotIn" }, { "$ref": "#/components/parameters/FacilityAkaEqualFold" }, { "$ref": "#/components/parameters/FacilityAkaContains" }, { "$ref": "#/components/parameters/FacilityAkaContainsFold" }, { "$ref": "#/components/parameters/FacilityAkaHasPrefix" }, { "$ref": "#/components/parameters/FacilityAkaHasSuffix" }, { "$ref": "#/components/parameters/FacilityCityEQ" }, { "$ref": "#/components/parameters/FacilityCityNEQ" }, { "$ref": "#/components/parameters/FacilityCityIsNil" }, { "$ref": "#/components/parameters/FacilityCityIn" }, { "$ref": "#/components/parameters/FacilityCityNotIn" }, { "$ref": "#/components/parameters/FacilityCityEqualFold" }, { "$ref": "#/components/parameters/FacilityCityContains" }, { "$ref": "#/components/parameters/FacilityCityContainsFold" }, { "$ref": "#/components/parameters/FacilityCityHasPrefix" }, { "$ref": "#/components/parameters/FacilityCityHasSuffix" }, { "$ref": "#/components/parameters/FacilityCountryEQ" }, { "$ref": "#/components/parameters/FacilityCountryNEQ" }, { "$ref": "#/components/parameters/FacilityCountryIsNil" }, { "$ref": "#/components/parameters/FacilityCountryIn" }, { "$ref": "#/components/parameters/FacilityCountryNotIn" }, { "$ref": "#/components/parameters/FacilityCountryEqualFold" }, { "$ref": "#/components/parameters/FacilityCountryContains" }, { "$ref": "#/components/parameters/FacilityCountryContainsFold" }, { "$ref": "#/components/parameters/FacilityCountryHasPrefix" }, { "$ref": "#/components/parameters/FacilityCountryHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameEQ" }, { "$ref": "#/components/parameters/FacilityNameNEQ" }, { "$ref": "#/components/parameters/FacilityNameIn" }, { "$ref": "#/components/parameters/FacilityNameNotIn" }, { "$ref": "#/components/parameters/FacilityNameEqualFold" }, { "$ref": "#/components/parameters/FacilityNameContains" }, { "$ref": "#/components/parameters/FacilityNameContainsFold" }, { "$ref": "#/components/parameters/FacilityNameHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameHasSuffix" }, { "$ref": "#/components/parameters/FacilityNameLongEQ" }, { "$ref": "#/components/parameters/FacilityNameLongNEQ" }, { "$ref": "#/components/parameters/FacilityNameLongIsNil" }, { "$ref": "#/components/parameters/FacilityNameLongIn" }, { "$ref": "#/components/parameters/FacilityNameLongNotIn" }, { "$ref": "#/components/parameters/FacilityNameLongEqualFold" }, { "$ref": "#/components/parameters/FacilityNameLongContains" }, { "$ref": "#/components/parameters/FacilityNameLongContainsFold" }, { "$ref": "#/components/parameters/FacilityNameLongHasPrefix" }, { "$ref": "#/components/parameters/FacilityNameLongHasSuffix" }, { "$ref": "#/components/parameters/FacilityStateEQ" }, { "$ref": "#/components/parameters/FacilityStateNEQ" }, { "$ref": "#/components/parameters/FacilityStateIsNil" }, { "$ref": "#/components/parameters/FacilityStateIn" }, { "$ref": "#/components/parameters/FacilityStateNotIn" }, { "$ref": "#/components/parameters/FacilityStateEqualFold" }, { "$ref": "#/components/parameters/FacilityStateContains" }, { "$ref": "#/components/parameters/FacilityStateContainsFold" }, { "$ref": "#/components/parameters/FacilityStateHasPrefix" }, { "$ref": "#/components/parameters/FacilityStateHasSuffix" }, { "$ref": "#/components/parameters/FacilityCreatedGT" }, { "$ref": "#/components/parameters/FacilityCreatedGTE" }, { "$ref": "#/components/parameters/FacilityCreatedLT" }, { "$ref": "#/components/parameters/FacilityCreatedLTE" }, { "$ref": "#/components/parameters/FacilityUpdatedGT" }, { "$ref": "#/components/parameters/FacilityUpdatedGTE" }, { "$ref": "#/components/parameters/FacilityUpdatedLT" }, { "$ref": "#/components/parameters/FacilityUpdatedLTE" }, { "$ref": "#/components/parameters/FacilityStatusEQ" }, { "$ref": "#/components/parameters/FacilityStatusNEQ" }, { "$ref": "#/components/parameters/FacilityStatusIn" }, { "$ref": "#/components/parameters/FacilityStatusNotIn" }, { "$ref": "#/components/parameters/FacilityStatusEqualFold" }, { "$ref": "#/components/parameters/FacilityStatusContains" }, { "$ref": "#/components/parameters/FacilityStatusContainsFold" }, { "$ref": "#/components/parameters/FacilityStatusHasPrefix" }, { "$ref": "#/components/parameters/FacilityStatusHasSuffix" } ], "responses": { "200": { "description": "The requested facilities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationFacilityList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/organizations/{organizationID}/internet-exchanges": { "summary": "List a organizations associated internetExchanges", "description": "List a organizations associated internetExchanges (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations", "InternetExchanges" ], "summary": "List a organizations associated internetExchanges", "description": "List a organizations associated internetExchanges (InternetExchange entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizationInternetExchanges", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/InternetExchangeSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDEQ" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDNEQ" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDIn" }, { "$ref": "#/components/parameters/InternetExchangeOrgIDNotIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaEQ" }, { "$ref": "#/components/parameters/InternetExchangeAkaNEQ" }, { "$ref": "#/components/parameters/InternetExchangeAkaIsNil" }, { "$ref": "#/components/parameters/InternetExchangeAkaIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaNotIn" }, { "$ref": "#/components/parameters/InternetExchangeAkaEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeAkaContains" }, { "$ref": "#/components/parameters/InternetExchangeAkaContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeAkaHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeAkaHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCityEQ" }, { "$ref": "#/components/parameters/InternetExchangeCityNEQ" }, { "$ref": "#/components/parameters/InternetExchangeCityIsNil" }, { "$ref": "#/components/parameters/InternetExchangeCityIn" }, { "$ref": "#/components/parameters/InternetExchangeCityNotIn" }, { "$ref": "#/components/parameters/InternetExchangeCityEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeCityContains" }, { "$ref": "#/components/parameters/InternetExchangeCityContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeCityHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeCityHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCountryEQ" }, { "$ref": "#/components/parameters/InternetExchangeCountryNEQ" }, { "$ref": "#/components/parameters/InternetExchangeCountryIsNil" }, { "$ref": "#/components/parameters/InternetExchangeCountryIn" }, { "$ref": "#/components/parameters/InternetExchangeCountryNotIn" }, { "$ref": "#/components/parameters/InternetExchangeCountryEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeCountryContains" }, { "$ref": "#/components/parameters/InternetExchangeCountryContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeCountryHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeCountryHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeNameEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameNEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameIn" }, { "$ref": "#/components/parameters/InternetExchangeNameNotIn" }, { "$ref": "#/components/parameters/InternetExchangeNameEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeNameContains" }, { "$ref": "#/components/parameters/InternetExchangeNameContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeNameHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeNameHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeNameLongEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameLongNEQ" }, { "$ref": "#/components/parameters/InternetExchangeNameLongIsNil" }, { "$ref": "#/components/parameters/InternetExchangeNameLongIn" }, { "$ref": "#/components/parameters/InternetExchangeNameLongNotIn" }, { "$ref": "#/components/parameters/InternetExchangeNameLongEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeNameLongContains" }, { "$ref": "#/components/parameters/InternetExchangeNameLongContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeNameLongHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeNameLongHasSuffix" }, { "$ref": "#/components/parameters/InternetExchangeCreatedGT" }, { "$ref": "#/components/parameters/InternetExchangeCreatedGTE" }, { "$ref": "#/components/parameters/InternetExchangeCreatedLT" }, { "$ref": "#/components/parameters/InternetExchangeCreatedLTE" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedGT" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedGTE" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedLT" }, { "$ref": "#/components/parameters/InternetExchangeUpdatedLTE" }, { "$ref": "#/components/parameters/InternetExchangeStatusEQ" }, { "$ref": "#/components/parameters/InternetExchangeStatusNEQ" }, { "$ref": "#/components/parameters/InternetExchangeStatusIn" }, { "$ref": "#/components/parameters/InternetExchangeStatusNotIn" }, { "$ref": "#/components/parameters/InternetExchangeStatusEqualFold" }, { "$ref": "#/components/parameters/InternetExchangeStatusContains" }, { "$ref": "#/components/parameters/InternetExchangeStatusContainsFold" }, { "$ref": "#/components/parameters/InternetExchangeStatusHasPrefix" }, { "$ref": "#/components/parameters/InternetExchangeStatusHasSuffix" } ], "responses": { "200": { "description": "The requested internetExchanges.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInternetExchangeList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/organizations/{organizationID}/networks": { "summary": "List a organizations associated networks", "description": "List a organizations associated networks (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Organizations", "Networks" ], "summary": "List a organizations associated networks", "description": "List a organizations associated networks (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listOrganizationNetworks", "parameters": [ { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/NetworkSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/NetworkOrgIDEQ" }, { "$ref": "#/components/parameters/NetworkOrgIDNEQ" }, { "$ref": "#/components/parameters/NetworkOrgIDIn" }, { "$ref": "#/components/parameters/NetworkOrgIDNotIn" }, { "$ref": "#/components/parameters/NetworkAkaEQ" }, { "$ref": "#/components/parameters/NetworkAkaNEQ" }, { "$ref": "#/components/parameters/NetworkAkaIsNil" }, { "$ref": "#/components/parameters/NetworkAkaIn" }, { "$ref": "#/components/parameters/NetworkAkaNotIn" }, { "$ref": "#/components/parameters/NetworkAkaEqualFold" }, { "$ref": "#/components/parameters/NetworkAkaContains" }, { "$ref": "#/components/parameters/NetworkAkaContainsFold" }, { "$ref": "#/components/parameters/NetworkAkaHasPrefix" }, { "$ref": "#/components/parameters/NetworkAkaHasSuffix" }, { "$ref": "#/components/parameters/NetworkAsnEQ" }, { "$ref": "#/components/parameters/NetworkAsnNEQ" }, { "$ref": "#/components/parameters/NetworkAsnGT" }, { "$ref": "#/components/parameters/NetworkAsnGTE" }, { "$ref": "#/components/parameters/NetworkAsnLT" }, { "$ref": "#/components/parameters/NetworkAsnLTE" }, { "$ref": "#/components/parameters/NetworkAsnIn" }, { "$ref": "#/components/parameters/NetworkAsnNotIn" }, { "$ref": "#/components/parameters/NetworkNameEQ" }, { "$ref": "#/components/parameters/NetworkNameNEQ" }, { "$ref": "#/components/parameters/NetworkNameIn" }, { "$ref": "#/components/parameters/NetworkNameNotIn" }, { "$ref": "#/components/parameters/NetworkNameEqualFold" }, { "$ref": "#/components/parameters/NetworkNameContains" }, { "$ref": "#/components/parameters/NetworkNameContainsFold" }, { "$ref": "#/components/parameters/NetworkNameHasPrefix" }, { "$ref": "#/components/parameters/NetworkNameHasSuffix" }, { "$ref": "#/components/parameters/NetworkNameLongEQ" }, { "$ref": "#/components/parameters/NetworkNameLongNEQ" }, { "$ref": "#/components/parameters/NetworkNameLongIsNil" }, { "$ref": "#/components/parameters/NetworkNameLongIn" }, { "$ref": "#/components/parameters/NetworkNameLongNotIn" }, { "$ref": "#/components/parameters/NetworkNameLongEqualFold" }, { "$ref": "#/components/parameters/NetworkNameLongContains" }, { "$ref": "#/components/parameters/NetworkNameLongContainsFold" }, { "$ref": "#/components/parameters/NetworkNameLongHasPrefix" }, { "$ref": "#/components/parameters/NetworkNameLongHasSuffix" }, { "$ref": "#/components/parameters/NetworkCreatedGT" }, { "$ref": "#/components/parameters/NetworkCreatedGTE" }, { "$ref": "#/components/parameters/NetworkCreatedLT" }, { "$ref": "#/components/parameters/NetworkCreatedLTE" }, { "$ref": "#/components/parameters/NetworkUpdatedGT" }, { "$ref": "#/components/parameters/NetworkUpdatedGTE" }, { "$ref": "#/components/parameters/NetworkUpdatedLT" }, { "$ref": "#/components/parameters/NetworkUpdatedLTE" }, { "$ref": "#/components/parameters/NetworkStatusEQ" }, { "$ref": "#/components/parameters/NetworkStatusNEQ" }, { "$ref": "#/components/parameters/NetworkStatusIn" }, { "$ref": "#/components/parameters/NetworkStatusNotIn" }, { "$ref": "#/components/parameters/NetworkStatusEqualFold" }, { "$ref": "#/components/parameters/NetworkStatusContains" }, { "$ref": "#/components/parameters/NetworkStatusContainsFold" }, { "$ref": "#/components/parameters/NetworkStatusHasPrefix" }, { "$ref": "#/components/parameters/NetworkStatusHasSuffix" } ], "responses": { "200": { "description": "The requested networks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationNetworkList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/OrganizationID" } ] }, "/pocs": { "summary": "List pocs", "description": "List Poc entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Pocs" ], "summary": "List pocs", "description": "List Poc entities (including pagination, filtering, sorting, etc). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "listPocs", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "name": "per_page", "in": "query", "description": "The number of entities to retrieve per page.", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort entity results by the given field.", "schema": { "$ref": "#/components/schemas/PocSortableFields", "default": "updated" } }, { "name": "order", "in": "query", "description": "Order the results in ascending or descending order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "$ref": "#/components/parameters/FilterOperation" }, { "$ref": "#/components/parameters/PocNetIDEQ" }, { "$ref": "#/components/parameters/PocNetIDNEQ" }, { "$ref": "#/components/parameters/PocNetIDIn" }, { "$ref": "#/components/parameters/PocNetIDNotIn" }, { "$ref": "#/components/parameters/PocEmailEQ" }, { "$ref": "#/components/parameters/PocEmailNEQ" }, { "$ref": "#/components/parameters/PocEmailIsNil" }, { "$ref": "#/components/parameters/PocEmailIn" }, { "$ref": "#/components/parameters/PocEmailNotIn" }, { "$ref": "#/components/parameters/PocEmailEqualFold" }, { "$ref": "#/components/parameters/PocEmailContains" }, { "$ref": "#/components/parameters/PocEmailContainsFold" }, { "$ref": "#/components/parameters/PocEmailHasPrefix" }, { "$ref": "#/components/parameters/PocEmailHasSuffix" }, { "$ref": "#/components/parameters/PocNameEQ" }, { "$ref": "#/components/parameters/PocNameNEQ" }, { "$ref": "#/components/parameters/PocNameIsNil" }, { "$ref": "#/components/parameters/PocNameIn" }, { "$ref": "#/components/parameters/PocNameNotIn" }, { "$ref": "#/components/parameters/PocNameEqualFold" }, { "$ref": "#/components/parameters/PocNameContains" }, { "$ref": "#/components/parameters/PocNameContainsFold" }, { "$ref": "#/components/parameters/PocNameHasPrefix" }, { "$ref": "#/components/parameters/PocNameHasSuffix" }, { "$ref": "#/components/parameters/PocRoleEQ" }, { "$ref": "#/components/parameters/PocRoleNEQ" }, { "$ref": "#/components/parameters/PocRoleIn" }, { "$ref": "#/components/parameters/PocRoleNotIn" }, { "$ref": "#/components/parameters/PocRoleEqualFold" }, { "$ref": "#/components/parameters/PocRoleContains" }, { "$ref": "#/components/parameters/PocRoleContainsFold" }, { "$ref": "#/components/parameters/PocRoleHasPrefix" }, { "$ref": "#/components/parameters/PocRoleHasSuffix" }, { "$ref": "#/components/parameters/PocVisibleEQ" }, { "$ref": "#/components/parameters/PocVisibleNEQ" }, { "$ref": "#/components/parameters/PocVisibleIsNil" }, { "$ref": "#/components/parameters/PocVisibleIn" }, { "$ref": "#/components/parameters/PocVisibleNotIn" }, { "$ref": "#/components/parameters/PocVisibleEqualFold" }, { "$ref": "#/components/parameters/PocVisibleContains" }, { "$ref": "#/components/parameters/PocVisibleContainsFold" }, { "$ref": "#/components/parameters/PocVisibleHasPrefix" }, { "$ref": "#/components/parameters/PocVisibleHasSuffix" }, { "$ref": "#/components/parameters/PocCreatedGT" }, { "$ref": "#/components/parameters/PocCreatedGTE" }, { "$ref": "#/components/parameters/PocCreatedLT" }, { "$ref": "#/components/parameters/PocCreatedLTE" }, { "$ref": "#/components/parameters/PocUpdatedGT" }, { "$ref": "#/components/parameters/PocUpdatedGTE" }, { "$ref": "#/components/parameters/PocUpdatedLT" }, { "$ref": "#/components/parameters/PocUpdatedLTE" }, { "$ref": "#/components/parameters/PocStatusEQ" }, { "$ref": "#/components/parameters/PocStatusNEQ" }, { "$ref": "#/components/parameters/PocStatusIn" }, { "$ref": "#/components/parameters/PocStatusNotIn" }, { "$ref": "#/components/parameters/PocStatusEqualFold" }, { "$ref": "#/components/parameters/PocStatusContains" }, { "$ref": "#/components/parameters/PocStatusContainsFold" }, { "$ref": "#/components/parameters/PocStatusHasPrefix" }, { "$ref": "#/components/parameters/PocStatusHasSuffix" } ], "responses": { "200": { "description": "The requested Poc.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PocList" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" } ] }, "/pocs/{pocID}": { "summary": "Operate on a single Poc entity", "description": "Operate on a single Poc entity by its ID.", "get": { "tags": [ "Pocs" ], "summary": "Retrieve a poc", "description": "Retrieve a single Poc entity by its ID. If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getPoc", "responses": { "200": { "description": "The requested Poc entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PocRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/PocID" } ] }, "/pocs/{pocID}/network": { "summary": "Get a pocs associated network", "description": "Get a pocs associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "get": { "tags": [ "Pocs", "Networks" ], "summary": "Get a pocs associated network", "description": "Get a pocs associated network (Network entity type). If the entity has eager-loaded edges, the depth of when those will be loaded is limited to a depth of 1 (entity -\u003e edge, not entity -\u003e edge -\u003e edge -\u003e etc).", "operationId": "getPocNetwork", "responses": { "200": { "description": "The requested network entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRead" } } } }, "400": { "$ref": "#/components/responses/ErrorBadRequest" }, "401": { "$ref": "#/components/responses/ErrorUnauthorized" }, "403": { "$ref": "#/components/responses/ErrorForbidden" }, "404": { "$ref": "#/components/responses/ErrorNotFound" }, "429": { "$ref": "#/components/responses/ErrorTooManyRequests" }, "500": { "$ref": "#/components/responses/ErrorInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/PrettyResponse" }, { "$ref": "#/components/parameters/PocID" } ] } }, "components": { "schemas": { "Campus": { "description": "A single Campus entity.", "type": "object", "properties": { "id": { "description": "The ID of the Campus entity.", "type": "integer" }, "org_id": { "description": "FK to organization", "type": "integer", "nullable": true }, "aka": { "description": "Also known as", "type": "string", "nullable": true }, "city": { "description": "City", "type": "string", "default": "" }, "country": { "description": "Country code", "type": "string", "default": "" }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "name": { "description": "Campus name (not unique — PeeringDB permits duplicates)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "nullable": true }, "notes": { "description": "Notes", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "state": { "description": "State or province", "type": "string", "default": "" }, "website": { "description": "Campus website URL", "type": "string", "default": "" }, "zipcode": { "description": "Postal / ZIP code", "type": "string", "default": "" }, "org_name": { "description": "Org Name (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "name", "created", "updated", "status" ] }, "CampusEdges": { "type": "object", "properties": { "facilities": { "description": "A list of Facility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Facility" }, "maxItems": 1000, "minItems": 0 }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "CampusFacilityList": { "description": "List of facilities associated with campuses (facility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/FacilityRead" } }, "CampusList": { "description": "A paginated result set of Campus entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/CampusRead" } } }, "required": [ "content" ] } ] }, "CampusRead": { "description": "A single Campus entity.", "allOf": [ { "$ref": "#/components/schemas/Campus" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/CampusEdges" } }, "required": [ "edges" ] } ] }, "CampusSortableFields": { "description": "All potential sortable fields for Campus entities.", "type": "string", "enum": [ "facilities.count", "id", "organization.updated", "random", "updated" ], "default": "id" }, "Carrier": { "description": "A single Carrier entity.", "type": "object", "properties": { "id": { "description": "The ID of the Carrier entity.", "type": "integer" }, "org_id": { "description": "FK to organization", "type": "integer", "nullable": true }, "aka": { "description": "Also known as", "type": "string", "default": "" }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "name": { "description": "Carrier name (not unique — PeeringDB permits duplicates)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "default": "" }, "notes": { "description": "Notes", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "website": { "description": "Carrier website URL", "type": "string", "default": "" }, "org_name": { "description": "Org Name (computed)", "type": "string", "default": "" }, "fac_count": { "description": "Fac Count (computed)", "type": "integer", "default": 0 }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "name", "created", "updated", "status" ] }, "CarrierCarrierFacilityList": { "description": "List of carrierFacilities associated with carriers (carrierfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/CarrierFacilityRead" } }, "CarrierEdges": { "type": "object", "properties": { "carrier_facilities": { "description": "A list of CarrierFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/CarrierFacility" }, "maxItems": 1000, "minItems": 0 }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "CarrierFacility": { "description": "A single CarrierFacility entity.", "type": "object", "properties": { "id": { "description": "The ID of the CarrierFacility entity.", "type": "integer" }, "carrier_id": { "description": "FK to carrier", "type": "integer", "nullable": true }, "fac_id": { "description": "FK to facility", "type": "integer", "nullable": true }, "name": { "description": "Name (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "created", "updated", "status" ] }, "CarrierFacilityEdges": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "facility": { "$ref": "#/components/schemas/Facility" } } }, "CarrierFacilityList": { "description": "A paginated result set of CarrierFacility entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierFacilityRead" } } }, "required": [ "content" ] } ] }, "CarrierFacilityRead": { "description": "A single CarrierFacility entity.", "allOf": [ { "$ref": "#/components/schemas/CarrierFacility" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/CarrierFacilityEdges" } }, "required": [ "edges" ] } ] }, "CarrierFacilitySortableFields": { "description": "All potential sortable fields for CarrierFacility entities.", "type": "string", "enum": [ "carrier.updated", "facility.updated", "id", "random", "updated" ], "default": "id" }, "CarrierList": { "description": "A paginated result set of Carrier entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierRead" } } }, "required": [ "content" ] } ] }, "CarrierRead": { "description": "A single Carrier entity.", "allOf": [ { "$ref": "#/components/schemas/Carrier" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/CarrierEdges" } }, "required": [ "edges" ] } ] }, "CarrierSortableFields": { "description": "All potential sortable fields for Carrier entities.", "type": "string", "enum": [ "carrier_facilities.count", "id", "organization.updated", "random", "updated" ], "default": "id" }, "ErrorBadRequest": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Bad Request" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 400 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorConflict": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Conflict" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 409 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorForbidden": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Forbidden" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 403 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorInternalServerError": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Internal Server Error" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 500 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorNotFound": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Not Found" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 404 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorTooManyRequests": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Too Many Requests" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 429 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "ErrorUnauthorized": { "type": "object", "properties": { "error": { "description": "The underlying error, which may be masked when debugging is disabled.", "type": "string" }, "type": { "description": "A summary of the error code based off the HTTP status code or application error code.", "type": "string", "example": "Unauthorized" }, "code": { "description": "The HTTP status code or other internal application error code.", "type": "integer", "example": 401 }, "request_id": { "description": "The unique request ID for this error.", "type": "string", "example": "cb6f6f9c1783cdc9752cee2a4e95dd4c" }, "timestamp": { "description": "The timestamp of the error, in RFC3339 format.", "type": "string", "format": "date-time", "example": "2024-04-26T12:19:01Z" } }, "required": [ "error", "type", "code", "timestamp" ] }, "Facility": { "description": "A single Facility entity.", "type": "object", "properties": { "id": { "description": "The ID of the Facility entity.", "type": "integer" }, "campus_id": { "description": "FK to campus", "type": "integer", "nullable": true }, "org_id": { "description": "FK to organization", "type": "integer", "nullable": true }, "address1": { "description": "Address line 1", "type": "string", "default": "" }, "address2": { "description": "Address line 2", "type": "string", "default": "" }, "aka": { "description": "Also known as", "type": "string", "default": "" }, "available_voltage_services": { "description": "Available voltage services", "type": "array", "items": { "type": "string" } }, "city": { "description": "City", "type": "string", "default": "" }, "clli": { "description": "CLLI code", "type": "string", "default": "" }, "country": { "description": "Country code", "type": "string", "default": "" }, "diverse_serving_substations": { "description": "Diverse serving substations", "type": "boolean", "nullable": true }, "floor": { "description": "Floor", "type": "string", "default": "" }, "latitude": { "description": "Latitude", "type": "number", "format": "double", "nullable": true }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "longitude": { "description": "Longitude", "type": "number", "format": "double", "nullable": true }, "name": { "description": "Facility name (not unique — PeeringDB permits duplicates)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "default": "" }, "notes": { "description": "Notes", "type": "string", "default": "" }, "npanxx": { "description": "NPA-NXX code", "type": "string", "default": "" }, "property": { "description": "Property type", "type": "string", "nullable": true }, "region_continent": { "description": "Region/continent", "type": "string", "nullable": true }, "rencode": { "description": "Rencode", "type": "string", "default": "" }, "sales_email": { "description": "Sales email", "type": "string", "default": "" }, "sales_phone": { "description": "Sales phone", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "state": { "description": "State or province", "type": "string", "default": "" }, "status_dashboard": { "description": "Status dashboard URL", "type": "string", "nullable": true }, "suite": { "description": "Suite number", "type": "string", "default": "" }, "tech_email": { "description": "Technical email", "type": "string", "default": "" }, "tech_phone": { "description": "Technical phone", "type": "string", "default": "" }, "website": { "description": "Facility website URL", "type": "string", "default": "" }, "zipcode": { "description": "Postal / ZIP code", "type": "string", "default": "" }, "org_name": { "description": "Org Name (computed)", "type": "string", "default": "" }, "net_count": { "description": "Net Count (computed)", "type": "integer", "default": 0 }, "ix_count": { "description": "Ix Count (computed)", "type": "integer", "default": 0 }, "carrier_count": { "description": "Carrier Count (computed)", "type": "integer", "default": 0 }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "name", "created", "updated", "status" ] }, "FacilityCarrierFacilityList": { "description": "List of carrierFacilities associated with facilities (carrierfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/CarrierFacilityRead" } }, "FacilityEdges": { "type": "object", "properties": { "campus": { "$ref": "#/components/schemas/Campus" }, "carrier_facilities": { "description": "A list of CarrierFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/CarrierFacility" }, "maxItems": 1000, "minItems": 0 }, "ix_facilities": { "description": "A list of IxFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/IxFacility" }, "maxItems": 1000, "minItems": 0 }, "network_facilities": { "description": "A list of NetworkFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/NetworkFacility" }, "maxItems": 1000, "minItems": 0 }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "FacilityIxFacilityList": { "description": "List of ixFacilities associated with facilities (ixfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/IxFacilityRead" } }, "FacilityList": { "description": "A paginated result set of Facility entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/FacilityRead" } } }, "required": [ "content" ] } ] }, "FacilityNetworkFacilityList": { "description": "List of networkFacilities associated with facilities (networkfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/NetworkFacilityRead" } }, "FacilityRead": { "description": "A single Facility entity.", "allOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/FacilityEdges" } }, "required": [ "edges" ] } ] }, "FacilitySortableFields": { "description": "All potential sortable fields for Facility entities.", "type": "string", "enum": [ "campus.updated", "carrier_facilities.count", "id", "ix_facilities.count", "network_facilities.count", "organization.updated", "random", "updated" ], "default": "id" }, "FilterOperation": { "description": "Specifies how to combine multiple filters.", "type": "string", "enum": [ "and", "or" ], "default": "and" }, "InternetExchange": { "description": "A single InternetExchange entity.", "type": "object", "properties": { "id": { "description": "The ID of the InternetExchange entity.", "type": "integer" }, "org_id": { "description": "FK to organization", "type": "integer", "nullable": true }, "aka": { "description": "Also known as", "type": "string", "default": "" }, "city": { "description": "City", "type": "string", "default": "" }, "country": { "description": "Country code", "type": "string", "default": "" }, "ixf_last_import": { "description": "IXF last import timestamp", "type": "string", "format": "date-time", "nullable": true }, "ixf_net_count": { "description": "IXF net count", "type": "integer", "default": 0 }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "media": { "description": "Exchange media type", "type": "string", "default": "Ethernet" }, "name": { "description": "Internet exchange name (not unique — PeeringDB permits duplicates)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "default": "" }, "notes": { "description": "Notes", "type": "string", "default": "" }, "policy_email": { "description": "Policy email", "type": "string", "default": "" }, "policy_phone": { "description": "Policy phone", "type": "string", "default": "" }, "proto_ipv6": { "description": "Supports IPv6", "type": "boolean", "default": false }, "proto_multicast": { "description": "Supports multicast", "type": "boolean", "default": false }, "proto_unicast": { "description": "Supports unicast", "type": "boolean", "default": false }, "region_continent": { "description": "Region/continent", "type": "string", "default": "" }, "sales_email": { "description": "Sales email", "type": "string", "default": "" }, "sales_phone": { "description": "Sales phone", "type": "string", "default": "" }, "service_level": { "description": "Service level", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "status_dashboard": { "description": "Status dashboard URL", "type": "string", "nullable": true }, "tech_email": { "description": "Technical email", "type": "string", "default": "" }, "tech_phone": { "description": "Technical phone", "type": "string", "default": "" }, "terms": { "description": "Terms", "type": "string", "default": "" }, "url_stats": { "description": "Statistics URL", "type": "string", "default": "" }, "website": { "description": "IX website URL", "type": "string", "default": "" }, "net_count": { "description": "Net Count (computed)", "type": "integer", "default": 0 }, "fac_count": { "description": "Fac Count (computed)", "type": "integer", "default": 0 }, "ixf_import_request": { "description": "Ixf Import Request (computed)", "type": "string", "nullable": true }, "ixf_import_request_status": { "description": "Ixf Import Request Status (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "name", "proto_ipv6", "proto_multicast", "proto_unicast", "created", "updated", "status" ] }, "InternetExchangeEdges": { "type": "object", "properties": { "ix_facilities": { "description": "A list of IxFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/IxFacility" }, "maxItems": 1000, "minItems": 0 }, "ix_lans": { "description": "A list of IxLan entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/IxLan" }, "maxItems": 1000, "minItems": 0 }, "organization": { "$ref": "#/components/schemas/Organization" } } }, "InternetExchangeIxFacilityList": { "description": "List of ixFacilities associated with internetexchanges (ixfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/IxFacilityRead" } }, "InternetExchangeIxLanList": { "description": "List of ixLans associated with internetexchanges (ixlan entity type).", "type": "array", "items": { "$ref": "#/components/schemas/IxLanRead" } }, "InternetExchangeList": { "description": "A paginated result set of InternetExchange entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/InternetExchangeRead" } } }, "required": [ "content" ] } ] }, "InternetExchangeRead": { "description": "A single InternetExchange entity.", "allOf": [ { "$ref": "#/components/schemas/InternetExchange" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/InternetExchangeEdges" } }, "required": [ "edges" ] } ] }, "InternetExchangeSortableFields": { "description": "All potential sortable fields for InternetExchange entities.", "type": "string", "enum": [ "id", "ix_facilities.count", "ix_lans.count", "organization.updated", "random", "updated" ], "default": "id" }, "IxFacility": { "description": "A single IxFacility entity.", "type": "object", "properties": { "id": { "description": "The ID of the IxFacility entity.", "type": "integer" }, "fac_id": { "description": "FK to facility", "type": "integer", "nullable": true }, "ix_id": { "description": "FK to internet exchange", "type": "integer", "nullable": true }, "name": { "description": "Name (computed)", "type": "string", "default": "" }, "city": { "description": "City (computed)", "type": "string", "default": "" }, "country": { "description": "Country (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "created", "updated", "status" ] }, "IxFacilityEdges": { "type": "object", "properties": { "facility": { "$ref": "#/components/schemas/Facility" }, "internet_exchange": { "$ref": "#/components/schemas/InternetExchange" } } }, "IxFacilityList": { "description": "A paginated result set of IxFacility entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/IxFacilityRead" } } }, "required": [ "content" ] } ] }, "IxFacilityRead": { "description": "A single IxFacility entity.", "allOf": [ { "$ref": "#/components/schemas/IxFacility" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/IxFacilityEdges" } }, "required": [ "edges" ] } ] }, "IxFacilitySortableFields": { "description": "All potential sortable fields for IxFacility entities.", "type": "string", "enum": [ "facility.updated", "id", "internet_exchange.updated", "random", "updated" ], "default": "id" }, "IxLan": { "description": "A single IxLan entity.", "type": "object", "properties": { "id": { "description": "The ID of the IxLan entity.", "type": "integer" }, "ix_id": { "description": "FK to internet exchange", "type": "integer", "nullable": true }, "arp_sponge": { "description": "ARP sponge MAC address", "type": "string", "nullable": true }, "descr": { "description": "Description", "type": "string", "default": "" }, "dot1q_support": { "description": "802.1Q support", "type": "boolean", "default": false }, "ixf_ixp_import_enabled": { "description": "IXF import enabled", "type": "boolean", "default": false }, "ixf_ixp_member_list_url": { "description": "IXF IX-F member list URL (field-level gated by ixf_ixp_member_list_url_visible)", "type": "string", "default": "" }, "ixf_ixp_member_list_url_visible": { "description": "IXF member list URL visibility", "type": "string", "default": "Private" }, "mtu": { "description": "MTU size", "type": "integer", "default": 1500 }, "name": { "description": "LAN name", "type": "string", "default": "" }, "rs_asn": { "description": "Route server ASN", "type": "integer", "nullable": true, "default": 0 }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "dot1q_support", "ixf_ixp_import_enabled", "created", "updated", "status" ] }, "IxLanEdges": { "type": "object", "properties": { "internet_exchange": { "$ref": "#/components/schemas/InternetExchange" }, "ix_prefixes": { "description": "A list of IxPrefix entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/IxPrefix" }, "maxItems": 1000, "minItems": 0 }, "network_ix_lans": { "description": "A list of NetworkIxLan entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/NetworkIxLan" }, "maxItems": 1000, "minItems": 0 } } }, "IxLanIxPrefixList": { "description": "List of ixPrefixes associated with ixlans (ixprefix entity type).", "type": "array", "items": { "$ref": "#/components/schemas/IxPrefixRead" } }, "IxLanList": { "description": "A paginated result set of IxLan entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/IxLanRead" } } }, "required": [ "content" ] } ] }, "IxLanNetworkIxLanList": { "description": "List of networkIxLans associated with ixlans (networkixlan entity type).", "type": "array", "items": { "$ref": "#/components/schemas/NetworkIxLanRead" } }, "IxLanRead": { "description": "A single IxLan entity.", "allOf": [ { "$ref": "#/components/schemas/IxLan" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/IxLanEdges" } }, "required": [ "edges" ] } ] }, "IxLanSortableFields": { "description": "All potential sortable fields for IxLan entities.", "type": "string", "enum": [ "id", "internet_exchange.updated", "ix_prefixes.count", "network_ix_lans.count", "random", "updated" ], "default": "id" }, "IxPrefix": { "description": "A single IxPrefix entity.", "type": "object", "properties": { "id": { "description": "The ID of the IxPrefix entity.", "type": "integer" }, "ixlan_id": { "description": "FK to IX LAN", "type": "integer", "nullable": true }, "in_dfz": { "description": "In default-free zone", "type": "boolean", "default": false }, "prefix": { "description": "IP prefix (not unique — PeeringDB permits duplicates)", "type": "string" }, "protocol": { "description": "Protocol (IPv4/IPv6)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "in_dfz", "prefix", "created", "updated", "status" ] }, "IxPrefixEdges": { "type": "object", "properties": { "ix_lan": { "$ref": "#/components/schemas/IxLan" } } }, "IxPrefixList": { "description": "A paginated result set of IxPrefix entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/IxPrefixRead" } } }, "required": [ "content" ] } ] }, "IxPrefixRead": { "description": "A single IxPrefix entity.", "allOf": [ { "$ref": "#/components/schemas/IxPrefix" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/IxPrefixEdges" } }, "required": [ "edges" ] } ] }, "IxPrefixSortableFields": { "description": "All potential sortable fields for IxPrefix entities.", "type": "string", "enum": [ "id", "ix_lan.updated", "random", "updated" ], "default": "id" }, "Network": { "description": "A single Network entity.", "type": "object", "properties": { "id": { "description": "The ID of the Network entity.", "type": "integer" }, "org_id": { "description": "FK to organization", "type": "integer", "nullable": true }, "aka": { "description": "Also known as", "type": "string", "default": "" }, "allow_ixp_update": { "description": "Allow IXP update", "type": "boolean", "default": false }, "asn": { "description": "Autonomous System Number", "type": "integer" }, "info_ipv6": { "description": "Supports IPv6", "type": "boolean", "default": false }, "info_multicast": { "description": "Supports multicast", "type": "boolean", "default": false }, "info_never_via_route_servers": { "description": "Never via route servers", "type": "boolean", "default": false }, "info_prefixes4": { "description": "IPv4 prefix count", "type": "integer", "nullable": true }, "info_prefixes6": { "description": "IPv6 prefix count", "type": "integer", "nullable": true }, "info_ratio": { "description": "Traffic ratio", "type": "string", "default": "" }, "info_scope": { "description": "Geographic scope", "type": "string", "default": "" }, "info_traffic": { "description": "Traffic level", "type": "string", "default": "" }, "info_type": { "description": "Network type", "type": "string", "default": "" }, "info_types": { "description": "Network types (multi-choice)", "type": "array", "items": { "type": "string" } }, "info_unicast": { "description": "Supports unicast", "type": "boolean", "default": false }, "irr_as_set": { "description": "IRR AS-SET", "type": "string", "default": "" }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "looking_glass": { "description": "Looking glass URL", "type": "string", "default": "" }, "name": { "description": "Network name (not unique — PeeringDB permits duplicates)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "default": "" }, "notes": { "description": "Notes", "type": "string", "default": "" }, "policy_contracts": { "description": "Peering policy contracts", "type": "string", "default": "" }, "policy_general": { "description": "General peering policy", "type": "string", "default": "" }, "policy_locations": { "description": "Peering policy locations", "type": "string", "default": "" }, "policy_ratio": { "description": "Peering policy ratio requirement", "type": "boolean", "default": false }, "policy_url": { "description": "Peering policy URL", "type": "string", "default": "" }, "rir_status": { "description": "RIR status", "type": "string", "nullable": true }, "rir_status_updated": { "description": "RIR status last updated", "type": "string", "format": "date-time", "nullable": true }, "route_server": { "description": "Route server URL", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "status_dashboard": { "description": "Status dashboard URL", "type": "string", "nullable": true }, "website": { "description": "Network website URL", "type": "string", "default": "" }, "ix_count": { "description": "Ix Count (computed)", "type": "integer", "default": 0 }, "fac_count": { "description": "Fac Count (computed)", "type": "integer", "default": 0 }, "netixlan_updated": { "description": "Netixlan Updated (computed)", "type": "string", "format": "date-time", "nullable": true }, "netfac_updated": { "description": "Netfac Updated (computed)", "type": "string", "format": "date-time", "nullable": true }, "poc_updated": { "description": "Poc Updated (computed)", "type": "string", "format": "date-time", "nullable": true }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "allow_ixp_update", "asn", "info_ipv6", "info_multicast", "info_never_via_route_servers", "info_unicast", "name", "policy_ratio", "created", "updated", "status" ] }, "NetworkEdges": { "type": "object", "properties": { "network_facilities": { "description": "A list of NetworkFacility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/NetworkFacility" }, "maxItems": 1000, "minItems": 0 }, "network_ix_lans": { "description": "A list of NetworkIxLan entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/NetworkIxLan" }, "maxItems": 1000, "minItems": 0 }, "organization": { "$ref": "#/components/schemas/Organization" }, "pocs": { "description": "A list of Poc entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Poc" }, "maxItems": 1000, "minItems": 0 } } }, "NetworkFacility": { "description": "A single NetworkFacility entity.", "type": "object", "properties": { "id": { "description": "The ID of the NetworkFacility entity.", "type": "integer" }, "fac_id": { "description": "FK to facility", "type": "integer", "nullable": true }, "net_id": { "description": "FK to network", "type": "integer", "nullable": true }, "local_asn": { "description": "Local ASN", "type": "integer" }, "name": { "description": "Name (computed)", "type": "string", "default": "" }, "city": { "description": "City (computed)", "type": "string", "default": "" }, "country": { "description": "Country (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "local_asn", "created", "updated", "status" ] }, "NetworkFacilityEdges": { "type": "object", "properties": { "facility": { "$ref": "#/components/schemas/Facility" }, "network": { "$ref": "#/components/schemas/Network" } } }, "NetworkFacilityList": { "description": "A paginated result set of NetworkFacility entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkFacilityRead" } } }, "required": [ "content" ] } ] }, "NetworkFacilityRead": { "description": "A single NetworkFacility entity.", "allOf": [ { "$ref": "#/components/schemas/NetworkFacility" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/NetworkFacilityEdges" } }, "required": [ "edges" ] } ] }, "NetworkFacilitySortableFields": { "description": "All potential sortable fields for NetworkFacility entities.", "type": "string", "enum": [ "facility.updated", "id", "network.updated", "random", "updated" ], "default": "id" }, "NetworkIxLan": { "description": "A single NetworkIxLan entity.", "type": "object", "properties": { "id": { "description": "The ID of the NetworkIxLan entity.", "type": "integer" }, "ix_side_id": { "description": "IX-side facility FK", "type": "integer", "nullable": true }, "ixlan_id": { "description": "FK to IX LAN", "type": "integer", "nullable": true }, "net_id": { "description": "FK to network", "type": "integer", "nullable": true }, "net_side_id": { "description": "Net-side facility FK", "type": "integer", "nullable": true }, "asn": { "description": "Autonomous System Number", "type": "integer" }, "bfd_support": { "description": "BFD support", "type": "boolean", "default": false }, "ipaddr4": { "description": "IPv4 address", "type": "string", "nullable": true }, "ipaddr6": { "description": "IPv6 address", "type": "string", "nullable": true }, "is_rs_peer": { "description": "Route server peer", "type": "boolean", "default": false }, "notes": { "description": "Notes", "type": "string", "default": "" }, "operational": { "description": "Operational status", "type": "boolean", "default": true }, "speed": { "description": "Port speed in Mbps", "type": "integer" }, "ix_id": { "description": "Internet exchange ID (computed)", "type": "integer" }, "name": { "description": "Name (computed)", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "asn", "bfd_support", "is_rs_peer", "operational", "speed", "created", "updated", "status" ] }, "NetworkIxLanEdges": { "type": "object", "properties": { "ix_lan": { "$ref": "#/components/schemas/IxLan" }, "network": { "$ref": "#/components/schemas/Network" } } }, "NetworkIxLanList": { "description": "A paginated result set of NetworkIxLan entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkIxLanRead" } } }, "required": [ "content" ] } ] }, "NetworkIxLanRead": { "description": "A single NetworkIxLan entity.", "allOf": [ { "$ref": "#/components/schemas/NetworkIxLan" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/NetworkIxLanEdges" } }, "required": [ "edges" ] } ] }, "NetworkIxLanSortableFields": { "description": "All potential sortable fields for NetworkIxLan entities.", "type": "string", "enum": [ "id", "ix_lan.updated", "network.updated", "random", "updated" ], "default": "id" }, "NetworkList": { "description": "A paginated result set of Network entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkRead" } } }, "required": [ "content" ] } ] }, "NetworkNetworkFacilityList": { "description": "List of networkFacilities associated with networks (networkfacility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/NetworkFacilityRead" } }, "NetworkNetworkIxLanList": { "description": "List of networkIxLans associated with networks (networkixlan entity type).", "type": "array", "items": { "$ref": "#/components/schemas/NetworkIxLanRead" } }, "NetworkPocList": { "description": "List of pocs associated with networks (poc entity type).", "type": "array", "items": { "$ref": "#/components/schemas/PocRead" } }, "NetworkRead": { "description": "A single Network entity.", "allOf": [ { "$ref": "#/components/schemas/Network" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/NetworkEdges" } }, "required": [ "edges" ] } ] }, "NetworkSortableFields": { "description": "All potential sortable fields for Network entities.", "type": "string", "enum": [ "id", "network_facilities.count", "network_ix_lans.count", "organization.updated", "pocs.count", "random", "updated" ], "default": "id" }, "Organization": { "description": "A single Organization entity.", "type": "object", "properties": { "id": { "description": "The ID of the Organization entity.", "type": "integer" }, "address1": { "description": "Address line 1", "type": "string", "default": "" }, "address2": { "description": "Address line 2", "type": "string", "default": "" }, "aka": { "description": "Also known as", "type": "string", "default": "" }, "city": { "description": "City", "type": "string", "default": "" }, "country": { "description": "Country code", "type": "string", "default": "" }, "floor": { "description": "Floor", "type": "string", "default": "" }, "latitude": { "description": "Latitude", "type": "number", "format": "double", "nullable": true }, "logo": { "description": "Logo URL", "type": "string", "nullable": true }, "longitude": { "description": "Longitude", "type": "number", "format": "double", "nullable": true }, "name": { "description": "Organization name (not unique — PeeringDB permits duplicates; observed 2026-04-04 when upstream began serving duplicate display names, breaking every sync with UNIQUE constraint failed)", "type": "string" }, "name_long": { "description": "Long name", "type": "string", "default": "" }, "notes": { "description": "Notes", "type": "string", "default": "" }, "social_media": { "description": "Social media links", "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "service": { "type": "string" } }, "required": [ "service", "identifier" ] } }, "state": { "description": "State or province", "type": "string", "default": "" }, "suite": { "description": "Suite number", "type": "string", "default": "" }, "website": { "description": "Organization website URL", "type": "string", "default": "" }, "zipcode": { "description": "Postal / ZIP code", "type": "string", "default": "" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "name", "created", "updated", "status" ] }, "OrganizationCampusList": { "description": "List of campuses associated with organizations (campus entity type).", "type": "array", "items": { "$ref": "#/components/schemas/CampusRead" } }, "OrganizationCarrierList": { "description": "List of carriers associated with organizations (carrier entity type).", "type": "array", "items": { "$ref": "#/components/schemas/CarrierRead" } }, "OrganizationEdges": { "type": "object", "properties": { "campuses": { "description": "A list of Campus entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Campus" }, "maxItems": 1000, "minItems": 0 }, "carriers": { "description": "A list of Carrier entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Carrier" }, "maxItems": 1000, "minItems": 0 }, "facilities": { "description": "A list of Facility entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Facility" }, "maxItems": 1000, "minItems": 0 }, "internet_exchanges": { "description": "A list of InternetExchange entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/InternetExchange" }, "maxItems": 1000, "minItems": 0 }, "networks": { "description": "A list of Network entities. Limited to 1000 items. If there are more results than the limit, the results are capped and you must use the associated edge endpoint with pagination -- see also the 'EagerLoadLimit' config option.", "type": "array", "items": { "$ref": "#/components/schemas/Network" }, "maxItems": 1000, "minItems": 0 } } }, "OrganizationFacilityList": { "description": "List of facilities associated with organizations (facility entity type).", "type": "array", "items": { "$ref": "#/components/schemas/FacilityRead" } }, "OrganizationInternetExchangeList": { "description": "List of internetExchanges associated with organizations (internetexchange entity type).", "type": "array", "items": { "$ref": "#/components/schemas/InternetExchangeRead" } }, "OrganizationList": { "description": "A paginated result set of Organization entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationRead" } } }, "required": [ "content" ] } ] }, "OrganizationNetworkList": { "description": "List of networks associated with organizations (network entity type).", "type": "array", "items": { "$ref": "#/components/schemas/NetworkRead" } }, "OrganizationRead": { "description": "A single Organization entity.", "allOf": [ { "$ref": "#/components/schemas/Organization" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/OrganizationEdges" } }, "required": [ "edges" ] } ] }, "OrganizationSortableFields": { "description": "All potential sortable fields for Organization entities.", "type": "string", "enum": [ "campuses.count", "carriers.count", "facilities.count", "id", "internet_exchanges.count", "networks.count", "random", "updated" ], "default": "id" }, "PagedResponse": { "type": "object", "properties": { "page": { "description": "Page which the results are associated with.", "type": "integer", "minimum": 1, "example": 1 }, "last_page": { "description": "The number of the last page of results.", "type": "integer", "minimum": 1, "example": 3 }, "is_last_page": { "description": "If true, the current results are the last page of results.", "type": "boolean", "example": false }, "total_count": { "description": "The total number of results based on the provided query.", "type": "integer", "minimum": 0, "example": 123 } }, "required": [ "page", "last_page", "is_last_page", "total_count" ] }, "Poc": { "description": "A single Poc entity.", "type": "object", "properties": { "id": { "description": "The ID of the Poc entity.", "type": "integer" }, "net_id": { "description": "FK to network", "type": "integer", "nullable": true }, "email": { "description": "Email address", "type": "string", "default": "" }, "name": { "description": "Contact name", "type": "string", "default": "" }, "phone": { "description": "Phone number", "type": "string", "default": "" }, "role": { "description": "Contact role", "type": "string" }, "url": { "description": "URL", "type": "string", "default": "" }, "visible": { "description": "Visibility level", "type": "string", "default": "Public" }, "created": { "description": "PeeringDB creation timestamp", "type": "string", "format": "date-time" }, "updated": { "description": "PeeringDB last update timestamp", "type": "string", "format": "date-time" }, "status": { "description": "Record status", "type": "string", "default": "ok" } }, "required": [ "id", "role", "created", "updated", "status" ] }, "PocEdges": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/Network" } } }, "PocList": { "description": "A paginated result set of Poc entities. Includes eager-loaded edges (if any) for each entity.", "allOf": [ { "$ref": "#/components/schemas/PagedResponse" }, { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/PocRead" } } }, "required": [ "content" ] } ] }, "PocRead": { "description": "A single Poc entity.", "allOf": [ { "$ref": "#/components/schemas/Poc" }, { "type": "object", "properties": { "edges": { "$ref": "#/components/schemas/PocEdges" } }, "required": [ "edges" ] } ] }, "PocSortableFields": { "description": "All potential sortable fields for Poc entities.", "type": "string", "enum": [ "id", "network.updated", "random", "updated" ], "default": "id" } }, "responses": { "ErrorBadRequest": { "description": "Bad Request (http status code 400)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBadRequest" } } } }, "ErrorConflict": { "description": "Conflict (http status code 409)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorConflict" } } } }, "ErrorForbidden": { "description": "Forbidden (http status code 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorForbidden" } } } }, "ErrorInternalServerError": { "description": "Internal Server Error (http status code 500)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorInternalServerError" } } } }, "ErrorNotFound": { "description": "Not Found (http status code 404)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorNotFound" } } } }, "ErrorTooManyRequests": { "description": "Too Many Requests (http status code 429)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorTooManyRequests" } } } }, "ErrorUnauthorized": { "description": "Unauthorized (http status code 401)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorUnauthorized" } } } } }, "parameters": { "CampusAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "CampusAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "CampusAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "CampusAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "CampusAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "CampusCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "CampusCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "CampusCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "CampusCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "CampusCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "CampusCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "CampusCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "CampusCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusID": { "name": "campusID", "in": "path", "description": "The ID of the Campus to act upon.", "required": true, "schema": { "description": "PeeringDB campus ID", "type": "integer" } }, "CampusNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "CampusNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "CampusNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "CampusNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "CampusNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "CampusNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "CampusNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "CampusNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusOrgIDEQ": { "name": "orgID.eq", "in": "query", "description": "Filters field \"org_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "CampusOrgIDIn": { "name": "orgID.in", "in": "query", "description": "Filters field \"org_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CampusOrgIDNEQ": { "name": "orgID.neq", "in": "query", "description": "Filters field \"org_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "CampusOrgIDNotIn": { "name": "orgID.notIn", "in": "query", "description": "Filters field \"org_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CampusStateContains": { "name": "state.has", "in": "query", "description": "Filters field \"state\" to contain the provided value.", "schema": { "type": "string" } }, "CampusStateContainsFold": { "name": "state.ihas", "in": "query", "description": "Filters field \"state\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusStateEQ": { "name": "state.eq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusStateEqualFold": { "name": "state.ieq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusStateHasPrefix": { "name": "state.prefix", "in": "query", "description": "Filters field \"state\" to start with the provided value.", "schema": { "type": "string" } }, "CampusStateHasSuffix": { "name": "state.suffix", "in": "query", "description": "Filters field \"state\" to end with the provided value.", "schema": { "type": "string" } }, "CampusStateIn": { "name": "state.in", "in": "query", "description": "Filters field \"state\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusStateIsNil": { "name": "state.null", "in": "query", "description": "Filters field \"state\" to be null/nil.", "schema": { "type": "boolean" } }, "CampusStateNEQ": { "name": "state.neq", "in": "query", "description": "Filters field \"state\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusStateNotIn": { "name": "state.notIn", "in": "query", "description": "Filters field \"state\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "CampusStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "CampusStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CampusStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "CampusStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "CampusStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CampusStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CampusUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CampusUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "CarrierAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityCarrierIDEQ": { "name": "carrierID.eq", "in": "query", "description": "Filters field \"carrier_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "CarrierFacilityCarrierIDIn": { "name": "carrierID.in", "in": "query", "description": "Filters field \"carrier_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierFacilityCarrierIDNEQ": { "name": "carrierID.neq", "in": "query", "description": "Filters field \"carrier_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "CarrierFacilityCarrierIDNotIn": { "name": "carrierID.notIn", "in": "query", "description": "Filters field \"carrier_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierFacilityCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityFacIDEQ": { "name": "facID.eq", "in": "query", "description": "Filters field \"fac_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "CarrierFacilityFacIDIn": { "name": "facID.in", "in": "query", "description": "Filters field \"fac_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierFacilityFacIDNEQ": { "name": "facID.neq", "in": "query", "description": "Filters field \"fac_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "CarrierFacilityFacIDNotIn": { "name": "facID.notIn", "in": "query", "description": "Filters field \"fac_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierFacilityID": { "name": "carrierfacilityID", "in": "path", "description": "The ID of the CarrierFacility to act upon.", "required": true, "schema": { "description": "PeeringDB carrierfacility ID", "type": "integer" } }, "CarrierFacilityNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierFacilityNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierFacilityNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierFacilityNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierFacilityNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierFacilityNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierFacilityNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierFacilityNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "CarrierFacilityNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierFacilityNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierFacilityStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierFacilityStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierFacilityStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierFacilityStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierFacilityStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierFacilityStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierFacilityStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierFacilityStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierFacilityStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierFacilityUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierFacilityUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierID": { "name": "carrierID", "in": "path", "description": "The ID of the Carrier to act upon.", "required": true, "schema": { "description": "PeeringDB carrier ID", "type": "integer" } }, "CarrierNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "CarrierNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierOrgIDEQ": { "name": "orgID.eq", "in": "query", "description": "Filters field \"org_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "CarrierOrgIDIn": { "name": "orgID.in", "in": "query", "description": "Filters field \"org_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierOrgIDNEQ": { "name": "orgID.neq", "in": "query", "description": "Filters field \"org_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "CarrierOrgIDNotIn": { "name": "orgID.notIn", "in": "query", "description": "Filters field \"org_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "CarrierStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "CarrierStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "CarrierStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "CarrierStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "CarrierStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "CarrierStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "CarrierStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "CarrierUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "CarrierUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "FacilityAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityCampusIDEQ": { "name": "campusID.eq", "in": "query", "description": "Filters field \"campus_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "FacilityCampusIDIn": { "name": "campusID.in", "in": "query", "description": "Filters field \"campus_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "FacilityCampusIDNEQ": { "name": "campusID.neq", "in": "query", "description": "Filters field \"campus_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "FacilityCampusIDNotIn": { "name": "campusID.notIn", "in": "query", "description": "Filters field \"campus_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "FacilityCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "FacilityCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "FacilityCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityID": { "name": "facilityID", "in": "path", "description": "The ID of the Facility to act upon.", "required": true, "schema": { "description": "PeeringDB facility ID", "type": "integer" } }, "FacilityNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "FacilityNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityOrgIDEQ": { "name": "orgID.eq", "in": "query", "description": "Filters field \"org_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "FacilityOrgIDIn": { "name": "orgID.in", "in": "query", "description": "Filters field \"org_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "FacilityOrgIDNEQ": { "name": "orgID.neq", "in": "query", "description": "Filters field \"org_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "FacilityOrgIDNotIn": { "name": "orgID.notIn", "in": "query", "description": "Filters field \"org_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "FacilityStateContains": { "name": "state.has", "in": "query", "description": "Filters field \"state\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityStateContainsFold": { "name": "state.ihas", "in": "query", "description": "Filters field \"state\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityStateEQ": { "name": "state.eq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityStateEqualFold": { "name": "state.ieq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityStateHasPrefix": { "name": "state.prefix", "in": "query", "description": "Filters field \"state\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityStateHasSuffix": { "name": "state.suffix", "in": "query", "description": "Filters field \"state\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityStateIn": { "name": "state.in", "in": "query", "description": "Filters field \"state\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityStateIsNil": { "name": "state.null", "in": "query", "description": "Filters field \"state\" to be null/nil.", "schema": { "type": "boolean" } }, "FacilityStateNEQ": { "name": "state.neq", "in": "query", "description": "Filters field \"state\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityStateNotIn": { "name": "state.notIn", "in": "query", "description": "Filters field \"state\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "FacilityStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "FacilityStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "FacilityStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "FacilityStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "FacilityStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "FacilityStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "FacilityUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FacilityUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "FilterOperation": { "name": "filter_op", "in": "query", "description": "Filter operation to use.", "schema": { "$ref": "#/components/schemas/FilterOperation" } }, "InternetExchangeAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "InternetExchangeAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "InternetExchangeCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "InternetExchangeCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeID": { "name": "internetexchangeID", "in": "path", "description": "The ID of the InternetExchange to act upon.", "required": true, "schema": { "description": "PeeringDB internetexchange ID", "type": "integer" } }, "InternetExchangeNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "InternetExchangeNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeOrgIDEQ": { "name": "orgID.eq", "in": "query", "description": "Filters field \"org_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "InternetExchangeOrgIDIn": { "name": "orgID.in", "in": "query", "description": "Filters field \"org_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "InternetExchangeOrgIDNEQ": { "name": "orgID.neq", "in": "query", "description": "Filters field \"org_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "InternetExchangeOrgIDNotIn": { "name": "orgID.notIn", "in": "query", "description": "Filters field \"org_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "InternetExchangeStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "InternetExchangeStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "InternetExchangeStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "InternetExchangeStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "InternetExchangeStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "InternetExchangeStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "InternetExchangeUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "InternetExchangeUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "IxFacilityCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "IxFacilityCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "IxFacilityCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "IxFacilityCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "IxFacilityCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "IxFacilityCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "IxFacilityCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "IxFacilityCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityFacIDEQ": { "name": "facID.eq", "in": "query", "description": "Filters field \"fac_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "IxFacilityFacIDIn": { "name": "facID.in", "in": "query", "description": "Filters field \"fac_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxFacilityFacIDNEQ": { "name": "facID.neq", "in": "query", "description": "Filters field \"fac_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "IxFacilityFacIDNotIn": { "name": "facID.notIn", "in": "query", "description": "Filters field \"fac_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxFacilityID": { "name": "ixfacilityID", "in": "path", "description": "The ID of the IxFacility to act upon.", "required": true, "schema": { "description": "PeeringDB ixfacility ID", "type": "integer" } }, "IxFacilityIxIDEQ": { "name": "ixID.eq", "in": "query", "description": "Filters field \"ix_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "IxFacilityIxIDIn": { "name": "ixID.in", "in": "query", "description": "Filters field \"ix_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxFacilityIxIDNEQ": { "name": "ixID.neq", "in": "query", "description": "Filters field \"ix_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "IxFacilityIxIDNotIn": { "name": "ixID.notIn", "in": "query", "description": "Filters field \"ix_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxFacilityNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "IxFacilityNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "IxFacilityNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "IxFacilityNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "IxFacilityNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "IxFacilityStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxFacilityStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "IxFacilityStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "IxFacilityStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxFacilityStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxFacilityUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxFacilityUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanID": { "name": "ixlanID", "in": "path", "description": "The ID of the IxLan to act upon.", "required": true, "schema": { "description": "PeeringDB ixlan ID", "type": "integer" } }, "IxLanIxIDEQ": { "name": "ixID.eq", "in": "query", "description": "Filters field \"ix_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "IxLanIxIDIn": { "name": "ixID.in", "in": "query", "description": "Filters field \"ix_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxLanIxIDNEQ": { "name": "ixID.neq", "in": "query", "description": "Filters field \"ix_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "IxLanIxIDNotIn": { "name": "ixID.notIn", "in": "query", "description": "Filters field \"ix_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxLanNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "IxLanNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxLanNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxLanNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxLanNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "IxLanNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "IxLanNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxLanNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "IxLanNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxLanNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxLanStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "IxLanStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxLanStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxLanStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxLanStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "IxLanStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "IxLanStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxLanStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxLanStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxLanUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxLanUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixID": { "name": "ixprefixID", "in": "path", "description": "The ID of the IxPrefix to act upon.", "required": true, "schema": { "description": "PeeringDB ixprefix ID", "type": "integer" } }, "IxPrefixIxlanIDEQ": { "name": "ixlanID.eq", "in": "query", "description": "Filters field \"ixlan_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "IxPrefixIxlanIDIn": { "name": "ixlanID.in", "in": "query", "description": "Filters field \"ixlan_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxPrefixIxlanIDNEQ": { "name": "ixlanID.neq", "in": "query", "description": "Filters field \"ixlan_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "IxPrefixIxlanIDNotIn": { "name": "ixlanID.notIn", "in": "query", "description": "Filters field \"ixlan_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "IxPrefixStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "IxPrefixStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxPrefixStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "IxPrefixStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "IxPrefixStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "IxPrefixStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "IxPrefixStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxPrefixStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "IxPrefixStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "IxPrefixUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "IxPrefixUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkAsnEQ": { "name": "asn.eq", "in": "query", "description": "Filters field \"asn\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkAsnGT": { "name": "asn.gt", "in": "query", "description": "Filters field \"asn\" to be greater than the provided value.", "schema": { "type": "number" } }, "NetworkAsnGTE": { "name": "asn.gte", "in": "query", "description": "Filters field \"asn\" to be greater than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkAsnIn": { "name": "asn.in", "in": "query", "description": "Filters field \"asn\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkAsnLT": { "name": "asn.lt", "in": "query", "description": "Filters field \"asn\" to be less than the provided value.", "schema": { "type": "number" } }, "NetworkAsnLTE": { "name": "asn.lte", "in": "query", "description": "Filters field \"asn\" to be less than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkAsnNEQ": { "name": "asn.neq", "in": "query", "description": "Filters field \"asn\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkAsnNotIn": { "name": "asn.notIn", "in": "query", "description": "Filters field \"asn\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkFacilityCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkFacilityCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityFacIDEQ": { "name": "facID.eq", "in": "query", "description": "Filters field \"fac_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkFacilityFacIDIn": { "name": "facID.in", "in": "query", "description": "Filters field \"fac_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkFacilityFacIDNEQ": { "name": "facID.neq", "in": "query", "description": "Filters field \"fac_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkFacilityFacIDNotIn": { "name": "facID.notIn", "in": "query", "description": "Filters field \"fac_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkFacilityID": { "name": "networkfacilityID", "in": "path", "description": "The ID of the NetworkFacility to act upon.", "required": true, "schema": { "description": "PeeringDB networkfacility ID", "type": "integer" } }, "NetworkFacilityNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkFacilityNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkFacilityNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityNetIDEQ": { "name": "netID.eq", "in": "query", "description": "Filters field \"net_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkFacilityNetIDIn": { "name": "netID.in", "in": "query", "description": "Filters field \"net_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkFacilityNetIDNEQ": { "name": "netID.neq", "in": "query", "description": "Filters field \"net_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkFacilityNetIDNotIn": { "name": "netID.notIn", "in": "query", "description": "Filters field \"net_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkFacilityStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkFacilityStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkFacilityStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkFacilityStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkFacilityStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkFacilityUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkFacilityUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkID": { "name": "networkID", "in": "path", "description": "The ID of the Network to act upon.", "required": true, "schema": { "description": "PeeringDB network ID", "type": "integer" } }, "NetworkIxLanAsnEQ": { "name": "asn.eq", "in": "query", "description": "Filters field \"asn\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanAsnGT": { "name": "asn.gt", "in": "query", "description": "Filters field \"asn\" to be greater than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanAsnGTE": { "name": "asn.gte", "in": "query", "description": "Filters field \"asn\" to be greater than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanAsnIn": { "name": "asn.in", "in": "query", "description": "Filters field \"asn\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanAsnLT": { "name": "asn.lt", "in": "query", "description": "Filters field \"asn\" to be less than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanAsnLTE": { "name": "asn.lte", "in": "query", "description": "Filters field \"asn\" to be less than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanAsnNEQ": { "name": "asn.neq", "in": "query", "description": "Filters field \"asn\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanAsnNotIn": { "name": "asn.notIn", "in": "query", "description": "Filters field \"asn\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanID": { "name": "networkixlanID", "in": "path", "description": "The ID of the NetworkIxLan to act upon.", "required": true, "schema": { "description": "PeeringDB networkixlan ID", "type": "integer" } }, "NetworkIxLanIxSideIDEQ": { "name": "ixSideID.eq", "in": "query", "description": "Filters field \"ix_side_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanIxSideIDGT": { "name": "ixSideID.gt", "in": "query", "description": "Filters field \"ix_side_id\" to be greater than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanIxSideIDGTE": { "name": "ixSideID.gte", "in": "query", "description": "Filters field \"ix_side_id\" to be greater than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanIxSideIDIn": { "name": "ixSideID.in", "in": "query", "description": "Filters field \"ix_side_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanIxSideIDLT": { "name": "ixSideID.lt", "in": "query", "description": "Filters field \"ix_side_id\" to be less than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanIxSideIDLTE": { "name": "ixSideID.lte", "in": "query", "description": "Filters field \"ix_side_id\" to be less than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanIxSideIDNEQ": { "name": "ixSideID.neq", "in": "query", "description": "Filters field \"ix_side_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanIxSideIDNotIn": { "name": "ixSideID.notIn", "in": "query", "description": "Filters field \"ix_side_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanIxlanIDEQ": { "name": "ixlanID.eq", "in": "query", "description": "Filters field \"ixlan_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanIxlanIDIn": { "name": "ixlanID.in", "in": "query", "description": "Filters field \"ixlan_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanIxlanIDNEQ": { "name": "ixlanID.neq", "in": "query", "description": "Filters field \"ixlan_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanIxlanIDNotIn": { "name": "ixlanID.notIn", "in": "query", "description": "Filters field \"ixlan_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkIxLanNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkIxLanNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkIxLanNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkIxLanNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkIxLanNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkIxLanNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkIxLanNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkIxLanNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkIxLanNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkIxLanNetIDEQ": { "name": "netID.eq", "in": "query", "description": "Filters field \"net_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanNetIDIn": { "name": "netID.in", "in": "query", "description": "Filters field \"net_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanNetIDNEQ": { "name": "netID.neq", "in": "query", "description": "Filters field \"net_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanNetIDNotIn": { "name": "netID.notIn", "in": "query", "description": "Filters field \"net_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanNetSideIDEQ": { "name": "netSideID.eq", "in": "query", "description": "Filters field \"net_side_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanNetSideIDGT": { "name": "netSideID.gt", "in": "query", "description": "Filters field \"net_side_id\" to be greater than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanNetSideIDGTE": { "name": "netSideID.gte", "in": "query", "description": "Filters field \"net_side_id\" to be greater than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanNetSideIDIn": { "name": "netSideID.in", "in": "query", "description": "Filters field \"net_side_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanNetSideIDLT": { "name": "netSideID.lt", "in": "query", "description": "Filters field \"net_side_id\" to be less than the provided value.", "schema": { "type": "number" } }, "NetworkIxLanNetSideIDLTE": { "name": "netSideID.lte", "in": "query", "description": "Filters field \"net_side_id\" to be less than or equal to the provided value.", "schema": { "type": "number" } }, "NetworkIxLanNetSideIDNEQ": { "name": "netSideID.neq", "in": "query", "description": "Filters field \"net_side_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkIxLanNetSideIDNotIn": { "name": "netSideID.notIn", "in": "query", "description": "Filters field \"net_side_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkIxLanStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkIxLanStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkIxLanStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkIxLanStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkIxLanStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkIxLanStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkIxLanStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkIxLanStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkIxLanStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkIxLanUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkIxLanUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "NetworkNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkOrgIDEQ": { "name": "orgID.eq", "in": "query", "description": "Filters field \"org_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "NetworkOrgIDIn": { "name": "orgID.in", "in": "query", "description": "Filters field \"org_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkOrgIDNEQ": { "name": "orgID.neq", "in": "query", "description": "Filters field \"org_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "NetworkOrgIDNotIn": { "name": "orgID.notIn", "in": "query", "description": "Filters field \"org_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "NetworkStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "NetworkStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "NetworkStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "NetworkStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "NetworkStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "NetworkStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "NetworkStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "NetworkUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "NetworkUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationAkaContains": { "name": "aka.has", "in": "query", "description": "Filters field \"aka\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationAkaContainsFold": { "name": "aka.ihas", "in": "query", "description": "Filters field \"aka\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationAkaEQ": { "name": "aka.eq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationAkaEqualFold": { "name": "aka.ieq", "in": "query", "description": "Filters field \"aka\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationAkaHasPrefix": { "name": "aka.prefix", "in": "query", "description": "Filters field \"aka\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationAkaHasSuffix": { "name": "aka.suffix", "in": "query", "description": "Filters field \"aka\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationAkaIn": { "name": "aka.in", "in": "query", "description": "Filters field \"aka\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationAkaIsNil": { "name": "aka.null", "in": "query", "description": "Filters field \"aka\" to be null/nil.", "schema": { "type": "boolean" } }, "OrganizationAkaNEQ": { "name": "aka.neq", "in": "query", "description": "Filters field \"aka\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationAkaNotIn": { "name": "aka.notIn", "in": "query", "description": "Filters field \"aka\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationCityContains": { "name": "city.has", "in": "query", "description": "Filters field \"city\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationCityContainsFold": { "name": "city.ihas", "in": "query", "description": "Filters field \"city\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationCityEQ": { "name": "city.eq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationCityEqualFold": { "name": "city.ieq", "in": "query", "description": "Filters field \"city\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationCityHasPrefix": { "name": "city.prefix", "in": "query", "description": "Filters field \"city\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationCityHasSuffix": { "name": "city.suffix", "in": "query", "description": "Filters field \"city\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationCityIn": { "name": "city.in", "in": "query", "description": "Filters field \"city\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationCityIsNil": { "name": "city.null", "in": "query", "description": "Filters field \"city\" to be null/nil.", "schema": { "type": "boolean" } }, "OrganizationCityNEQ": { "name": "city.neq", "in": "query", "description": "Filters field \"city\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationCityNotIn": { "name": "city.notIn", "in": "query", "description": "Filters field \"city\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationCountryContains": { "name": "country.has", "in": "query", "description": "Filters field \"country\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationCountryContainsFold": { "name": "country.ihas", "in": "query", "description": "Filters field \"country\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationCountryEQ": { "name": "country.eq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationCountryEqualFold": { "name": "country.ieq", "in": "query", "description": "Filters field \"country\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationCountryHasPrefix": { "name": "country.prefix", "in": "query", "description": "Filters field \"country\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationCountryHasSuffix": { "name": "country.suffix", "in": "query", "description": "Filters field \"country\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationCountryIn": { "name": "country.in", "in": "query", "description": "Filters field \"country\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationCountryIsNil": { "name": "country.null", "in": "query", "description": "Filters field \"country\" to be null/nil.", "schema": { "type": "boolean" } }, "OrganizationCountryNEQ": { "name": "country.neq", "in": "query", "description": "Filters field \"country\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationCountryNotIn": { "name": "country.notIn", "in": "query", "description": "Filters field \"country\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationID": { "name": "organizationID", "in": "path", "description": "The ID of the Organization to act upon.", "required": true, "schema": { "description": "PeeringDB organization ID", "type": "integer" } }, "OrganizationNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationNameLongContains": { "name": "nameLong.has", "in": "query", "description": "Filters field \"name_long\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationNameLongContainsFold": { "name": "nameLong.ihas", "in": "query", "description": "Filters field \"name_long\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationNameLongEQ": { "name": "nameLong.eq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationNameLongEqualFold": { "name": "nameLong.ieq", "in": "query", "description": "Filters field \"name_long\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationNameLongHasPrefix": { "name": "nameLong.prefix", "in": "query", "description": "Filters field \"name_long\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationNameLongHasSuffix": { "name": "nameLong.suffix", "in": "query", "description": "Filters field \"name_long\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationNameLongIn": { "name": "nameLong.in", "in": "query", "description": "Filters field \"name_long\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationNameLongIsNil": { "name": "nameLong.null", "in": "query", "description": "Filters field \"name_long\" to be null/nil.", "schema": { "type": "boolean" } }, "OrganizationNameLongNEQ": { "name": "nameLong.neq", "in": "query", "description": "Filters field \"name_long\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationNameLongNotIn": { "name": "nameLong.notIn", "in": "query", "description": "Filters field \"name_long\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationStateContains": { "name": "state.has", "in": "query", "description": "Filters field \"state\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationStateContainsFold": { "name": "state.ihas", "in": "query", "description": "Filters field \"state\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationStateEQ": { "name": "state.eq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationStateEqualFold": { "name": "state.ieq", "in": "query", "description": "Filters field \"state\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationStateHasPrefix": { "name": "state.prefix", "in": "query", "description": "Filters field \"state\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationStateHasSuffix": { "name": "state.suffix", "in": "query", "description": "Filters field \"state\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationStateIn": { "name": "state.in", "in": "query", "description": "Filters field \"state\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationStateIsNil": { "name": "state.null", "in": "query", "description": "Filters field \"state\" to be null/nil.", "schema": { "type": "boolean" } }, "OrganizationStateNEQ": { "name": "state.neq", "in": "query", "description": "Filters field \"state\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationStateNotIn": { "name": "state.notIn", "in": "query", "description": "Filters field \"state\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "OrganizationStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "OrganizationStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "OrganizationStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "OrganizationStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "OrganizationStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "OrganizationStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "OrganizationUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "OrganizationUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "Page": { "name": "page", "in": "query", "description": "The page number to retrieve.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, "PocCreatedGT": { "name": "created.gt", "in": "query", "description": "Filters field \"created\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocCreatedGTE": { "name": "created.gte", "in": "query", "description": "Filters field \"created\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocCreatedLT": { "name": "created.lt", "in": "query", "description": "Filters field \"created\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocCreatedLTE": { "name": "created.lte", "in": "query", "description": "Filters field \"created\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocEmailContains": { "name": "email.has", "in": "query", "description": "Filters field \"email\" to contain the provided value.", "schema": { "type": "string" } }, "PocEmailContainsFold": { "name": "email.ihas", "in": "query", "description": "Filters field \"email\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocEmailEQ": { "name": "email.eq", "in": "query", "description": "Filters field \"email\" to be equal to the provided value.", "schema": { "type": "string" } }, "PocEmailEqualFold": { "name": "email.ieq", "in": "query", "description": "Filters field \"email\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocEmailHasPrefix": { "name": "email.prefix", "in": "query", "description": "Filters field \"email\" to start with the provided value.", "schema": { "type": "string" } }, "PocEmailHasSuffix": { "name": "email.suffix", "in": "query", "description": "Filters field \"email\" to end with the provided value.", "schema": { "type": "string" } }, "PocEmailIn": { "name": "email.in", "in": "query", "description": "Filters field \"email\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocEmailIsNil": { "name": "email.null", "in": "query", "description": "Filters field \"email\" to be null/nil.", "schema": { "type": "boolean" } }, "PocEmailNEQ": { "name": "email.neq", "in": "query", "description": "Filters field \"email\" to be not equal to the provided value.", "schema": { "type": "string" } }, "PocEmailNotIn": { "name": "email.notIn", "in": "query", "description": "Filters field \"email\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocID": { "name": "pocID", "in": "path", "description": "The ID of the Poc to act upon.", "required": true, "schema": { "description": "PeeringDB poc ID", "type": "integer" } }, "PocNameContains": { "name": "name.has", "in": "query", "description": "Filters field \"name\" to contain the provided value.", "schema": { "type": "string" } }, "PocNameContainsFold": { "name": "name.ihas", "in": "query", "description": "Filters field \"name\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocNameEQ": { "name": "name.eq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value.", "schema": { "type": "string" } }, "PocNameEqualFold": { "name": "name.ieq", "in": "query", "description": "Filters field \"name\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocNameHasPrefix": { "name": "name.prefix", "in": "query", "description": "Filters field \"name\" to start with the provided value.", "schema": { "type": "string" } }, "PocNameHasSuffix": { "name": "name.suffix", "in": "query", "description": "Filters field \"name\" to end with the provided value.", "schema": { "type": "string" } }, "PocNameIn": { "name": "name.in", "in": "query", "description": "Filters field \"name\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocNameIsNil": { "name": "name.null", "in": "query", "description": "Filters field \"name\" to be null/nil.", "schema": { "type": "boolean" } }, "PocNameNEQ": { "name": "name.neq", "in": "query", "description": "Filters field \"name\" to be not equal to the provided value.", "schema": { "type": "string" } }, "PocNameNotIn": { "name": "name.notIn", "in": "query", "description": "Filters field \"name\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocNetIDEQ": { "name": "netID.eq", "in": "query", "description": "Filters field \"net_id\" to be equal to the provided value.", "schema": { "type": "integer" } }, "PocNetIDIn": { "name": "netID.in", "in": "query", "description": "Filters field \"net_id\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "PocNetIDNEQ": { "name": "netID.neq", "in": "query", "description": "Filters field \"net_id\" to be not equal to the provided value.", "schema": { "type": "integer" } }, "PocNetIDNotIn": { "name": "netID.notIn", "in": "query", "description": "Filters field \"net_id\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "integer" } } }, "PocRoleContains": { "name": "role.has", "in": "query", "description": "Filters field \"role\" to contain the provided value.", "schema": { "type": "string" } }, "PocRoleContainsFold": { "name": "role.ihas", "in": "query", "description": "Filters field \"role\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocRoleEQ": { "name": "role.eq", "in": "query", "description": "Filters field \"role\" to be equal to the provided value.", "schema": { "type": "string" } }, "PocRoleEqualFold": { "name": "role.ieq", "in": "query", "description": "Filters field \"role\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocRoleHasPrefix": { "name": "role.prefix", "in": "query", "description": "Filters field \"role\" to start with the provided value.", "schema": { "type": "string" } }, "PocRoleHasSuffix": { "name": "role.suffix", "in": "query", "description": "Filters field \"role\" to end with the provided value.", "schema": { "type": "string" } }, "PocRoleIn": { "name": "role.in", "in": "query", "description": "Filters field \"role\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocRoleNEQ": { "name": "role.neq", "in": "query", "description": "Filters field \"role\" to be not equal to the provided value.", "schema": { "type": "string" } }, "PocRoleNotIn": { "name": "role.notIn", "in": "query", "description": "Filters field \"role\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocStatusContains": { "name": "status.has", "in": "query", "description": "Filters field \"status\" to contain the provided value.", "schema": { "type": "string" } }, "PocStatusContainsFold": { "name": "status.ihas", "in": "query", "description": "Filters field \"status\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocStatusEQ": { "name": "status.eq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value.", "schema": { "type": "string" } }, "PocStatusEqualFold": { "name": "status.ieq", "in": "query", "description": "Filters field \"status\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocStatusHasPrefix": { "name": "status.prefix", "in": "query", "description": "Filters field \"status\" to start with the provided value.", "schema": { "type": "string" } }, "PocStatusHasSuffix": { "name": "status.suffix", "in": "query", "description": "Filters field \"status\" to end with the provided value.", "schema": { "type": "string" } }, "PocStatusIn": { "name": "status.in", "in": "query", "description": "Filters field \"status\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocStatusNEQ": { "name": "status.neq", "in": "query", "description": "Filters field \"status\" to be not equal to the provided value.", "schema": { "type": "string" } }, "PocStatusNotIn": { "name": "status.notIn", "in": "query", "description": "Filters field \"status\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocUpdatedGT": { "name": "updated.gt", "in": "query", "description": "Filters field \"updated\" to be greater than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocUpdatedGTE": { "name": "updated.gte", "in": "query", "description": "Filters field \"updated\" to be greater than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocUpdatedLT": { "name": "updated.lt", "in": "query", "description": "Filters field \"updated\" to be less than the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocUpdatedLTE": { "name": "updated.lte", "in": "query", "description": "Filters field \"updated\" to be less than or equal to the provided value.", "schema": { "type": "string", "format": "date-time" } }, "PocVisibleContains": { "name": "visible.has", "in": "query", "description": "Filters field \"visible\" to contain the provided value.", "schema": { "type": "string" } }, "PocVisibleContainsFold": { "name": "visible.ihas", "in": "query", "description": "Filters field \"visible\" to contain the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocVisibleEQ": { "name": "visible.eq", "in": "query", "description": "Filters field \"visible\" to be equal to the provided value.", "schema": { "type": "string" } }, "PocVisibleEqualFold": { "name": "visible.ieq", "in": "query", "description": "Filters field \"visible\" to be equal to the provided value, case-insensitive.", "schema": { "type": "string" } }, "PocVisibleHasPrefix": { "name": "visible.prefix", "in": "query", "description": "Filters field \"visible\" to start with the provided value.", "schema": { "type": "string" } }, "PocVisibleHasSuffix": { "name": "visible.suffix", "in": "query", "description": "Filters field \"visible\" to end with the provided value.", "schema": { "type": "string" } }, "PocVisibleIn": { "name": "visible.in", "in": "query", "description": "Filters field \"visible\" to be within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PocVisibleIsNil": { "name": "visible.null", "in": "query", "description": "Filters field \"visible\" to be null/nil.", "schema": { "type": "boolean" } }, "PocVisibleNEQ": { "name": "visible.neq", "in": "query", "description": "Filters field \"visible\" to be not equal to the provided value.", "schema": { "type": "string" } }, "PocVisibleNotIn": { "name": "visible.notIn", "in": "query", "description": "Filters field \"visible\" to be not within the provided values.", "schema": { "type": "array", "items": { "type": "string" } } }, "PrettyResponse": { "name": "pretty", "in": "query", "description": "If set to true, any JSON response will be indented.", "schema": { "type": "boolean" } } } }, "tags": [ { "name": "Meta", "description": "Includes various endpoints for meta information about the service, like the OpenAPI spec, version, health, etc." }, { "name": "Campus" }, { "name": "Facilities" }, { "name": "Organizations" }, { "name": "Carriers" }, { "name": "CarrierFacilities" }, { "name": "IxFacilities" }, { "name": "NetworkFacilities" }, { "name": "InternetExchanges" }, { "name": "IxLans" }, { "name": "IxPrefixes" }, { "name": "NetworkIxLans" }, { "name": "Networks" }, { "name": "Pocs" } ] }