{"openapi":"3.0.0","info":{"title":"DNSFilter API","description":"\n**Note:** If you are a distributor integrating with DNSFilter, please check\n          out our [Distributors Development Guide](/docs/distributors).\n\n### Authentication\n\n- Authentication is required for most, but not all, endpoints.\n\n- Authentication is done by setting the `Authorization` request header.\n  The header value is the API key itself.\n  For example: `Authorization: eyJ...`\n\n- An API key can be obtained through the DNSFilter dashboard under\n  Account Settings. For additional information see\n  [this KB article](https://help.dnsfilter.com/hc/en-us/articles/21169189058323-API-Tokens).\n\n### Rate Limiting\n\n- All endpoints are rate limited.\n\n- The limits may vary by endpoint, but are generally consistent.\n\n- When the rate limit is exceeded the API will return the standard `429` HTTP status.\n\n- The following headers will also be provided in the response:\n  `Retry-After`, `RateLimit-Policy`, `RateLimit`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`.\n  For details on the values of these headers, see the following articles\n  [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After),\n  [here](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-08.html),\n  and [here](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-05.html).\n\n- For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/38202811088403-API-Rate-Limits).\n\n### Error Handling\n\n- The API uses standard HTTP status codes to indicate success or failure.\n\n- For _V1_ endpoints the response format is:\n  ```json\n  { \"error\": \"string\", \"type\": \"string(optional)\" }\n  ```\n- For _V2_ endpoints the response format is:\n  ```json\n  { \"error\": { \"message\": \"string\", \"type\": \"string(optional)\" } }\n  ```\n\n### Pagination\n\nFor the _V1_ endpoints, the pagination parameters are nested. That is to say,\nif passed as JSON they look like this: `{\"page[number]\": 1, \"page[size]\": 10}`.\n\nTo pass this information in the URL query string, it would be formatted like\nthis: `...?page%5Bnumber%5D=1\u0026page%5Bsize%5D=10`.\n\nIn this guide, the UI will indicate that `page` is an `object` and if you\nwant to set values when trying the request, you must enter it as if it was\nthe JSON above.\n\n### A Quick Example\n\nThe following will return information about the currently\nauthenticated user.\n\n```bash\n% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self\n\n{ \"data\": {\n    \"id\": \"12345\",\n    \"type\": \"users\",\n    \"attributes\": {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      ...additional fields...\n}}}\n```\n","version":"2026-08-20"},"servers":[{"url":"https://api.dnsfilter.com","description":"Production"}],"paths":{"/v1/agent_local_user_bulk_deletes":{"post":{"tags":["Agent Local User Bulk Deletes"],"operationId":"V1_Agent_Local_User_Bulk_Deletes-create","parameters":[{"name":"block_page","description":"Filter by block page name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"collection_id","description":"Filter by collection","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ArrayIntegerIsOp"}},{"name":"friendly_name","description":"Filter by friendly name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"name_search","description":"Search by friendly_name, falls back to user_name when friendly_name is absent","required":false,"in":"query","schema":{"type":"string"}},{"name":"policy_schedule","description":"Filter by policy or scheduled policy name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"search","description":"Filter by name or user_login","required":false,"in":"query","schema":{"type":"string"}},{"name":"user_login","description":"Filter by user login","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"user_name","description":"Filter by username","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent Local User bulk delete","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUserBulkDeletes"}}}}}}},"description":"Create an agent local user bulk delete.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_user_bulk_deletes","x-action":"create","requestBody":{"description":"User agent bulk delete information, ids overrides filters, exclude_ids removes agents from filtered set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentLocalUserBulkDeletes"}}}}}},"/v1/agent_local_user_bulk_deletes/{id}":{"get":{"tags":["Agent Local User Bulk Deletes"],"operationId":"V1_Agent_Local_User_Bulk_Deletes-show","parameters":[{"name":"id","description":"Id of agent local user bulk delete","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local user bulk delete","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUserBulkDeletes"}}}}}}},"description":"Gets an agent local user bulk delete by id.","summary":"Show bulk delete","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_user_bulk_deletes","x-action":"show"}},"/v1/agent_local_user_bulk_deletes/counts":{"get":{"tags":["Agent Local User Bulk Deletes"],"operationId":"V1_Agent_Local_User_Bulk_Deletes-counts","parameters":[{"name":"id","description":"Id of agent local user bulk delete","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local user bulk delete counts information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentLocalUserBulkDeletesCounts"}}}}},"description":"Gets an agent local user bulk delete count by bulk delete id.","summary":"Count","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_user_bulk_deletes","x-action":"counts"}},"/v1/agent_local_users":{"get":{"tags":["Agent Local Users"],"operationId":"V1_Agent_Local_Users-index","parameters":[{"name":"block_page","description":"Filter by block page name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"collection_id","description":"Filter by collection","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ArrayIntegerIsOp"}},{"name":"cybersight_enabled","description":"When true, use OpenSearch for activity in the time window: without user_agent_uuids, return extant ALUs seen on any Cybersight-eligible roaming client in the org(s); with user_agent_uuids, return ALUs seen on those roaming clients. When false, use Postgres only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"end_at","description":"ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true.","required":false,"in":"query","schema":{"type":"string"}},{"name":"friendly_name","description":"Filter by friendly name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"ids","description":"Filter to users whose IDs are in the specified list of values","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"in_a_collection","description":"filter by agent local users in a collection","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_id","description":"MSP ID. When provided, returns agent local users across all organizations belonging to this MSP.","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"filter by name. If friendly_name not found, will search by user_name","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"policy_schedule","description":"Filter by policy or scheduled policy name","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"search","description":"Filter by name or user_login","required":false,"in":"query","schema":{"type":"string"}},{"name":"sort","description":"Sort options, valid attributes: name, first_seen, last_seen. Prefix with - for descending (e.g. -first_seen)","required":false,"in":"query","schema":{"type":"string"}},{"name":"start_at","description":"ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted =\u003e last 91 days unless paired with end_at.","required":false,"in":"query","schema":{"type":"string"}},{"name":"user_agent_uuids","description":"Filter to users associated with these roaming clients. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG).","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"user_login","description":"Filter by user login","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"user_name","description":"Filter by username","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StringContainsOp"}},{"name":"user_policy_override","description":"When true, return only users with a policy or scheduled policy directly assigned. When false, return only users without a direct policy or scheduled policy assignment.","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local users basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentLocalUserSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets the agent local users associated to an organization with basic information.","summary":"Gets extant users","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_users","x-action":"index"}},"/v1/agent_local_users/all":{"get":{"tags":["Agent Local Users"],"operationId":"V1_Agent_Local_Users-all","parameters":[{"name":"cybersight_enabled","description":"When true, use OpenSearch for activity in the time window: without user_agent_uuids, return ALUs seen on any Cybersight-eligible roaming client in scope; with user_agent_uuids, return ALUs seen on those roaming clients. When false, use Postgres only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"end_at","description":"ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true.","required":false,"in":"query","schema":{"type":"string"}},{"name":"in_a_collection","description":"filter by agent local users in a collection","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"name","description":"filter by name. If friendly_name not found, will search by user_name","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"sort","description":"Sort options, valid attributes: name","required":false,"in":"query","schema":{"type":"string"}},{"name":"start_at","description":"ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted =\u003e last 91 days unless paired with end_at.","required":false,"in":"query","schema":{"type":"string"}},{"name":"user_agent_uuids","description":"Filter to users associated with these roaming clients. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG).","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"user_policy_override","description":"When true, return only users with a policy or scheduled policy directly assigned. When false, return only users without a direct policy or scheduled policy assignment.","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local users basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentLocalUserSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL agent local users associated to an user organization with basic information.","summary":"Gets ALL users","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_users","x-action":"all"}},"/v1/agent_local_users/{id}":{"get":{"tags":["Agent Local Users"],"operationId":"V1_Agent_Local_Users-show","parameters":[{"name":"id","description":"Agent local user ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local user basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUserSpec"}}}}}}},"description":"Gets basic information of the specified agent local user.","summary":"Show extant user","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_users","x-action":"show"},"patch":{"tags":["Agent Local Users"],"operationId":"V1_Agent_Local_Users-update","parameters":[{"name":"id","description":"Agent local user ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update agent local user with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Updated agent local user basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUserSpec"}}}}}}},"description":"Updates an agent local user with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_users","x-action":"update","requestBody":{"description":"Agent local user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentLocalUserUpdateSpec"}}}}},"delete":{"tags":["Agent Local Users"],"operationId":"V1_Agent_Local_Users-destroy","parameters":[{"name":"id","description":"Agent local user ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete agent local user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Deletes a agent local user.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/agent_local_users","x-action":"destroy"}},"/v1/api_keys":{"post":{"tags":["Api Keys"],"operationId":"V1_Api_Keys-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create api_key with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"201":{"description":"created api key","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApiKeySpec"}}}}}}},"description":"Creates a new api key.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/api_keys","x-action":"create","requestBody":{"description":"api key information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreateSpec"}}}}},"get":{"tags":["Api Keys"],"operationId":"V1_Api_Keys-index","parameters":[{"name":"expired","description":"if the api key is expired or not.","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"id","description":"id of the api key","required":false,"in":"query","schema":{"type":"integer"}},{"name":"last_four","description":"last four values of api key token","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"name of api key","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"api keys","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets the list of api keys associated with the current user.","summary":"List","security":[{"header_authorization":[]}],"x-controller":"v1/api_keys","x-action":"index"}},"/v1/api_keys/{id}":{"get":{"tags":["Api Keys"],"operationId":"V1_Api_Keys-show","parameters":[{"name":"id","description":"ApiKey ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update api key with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"queried api key","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApiKeySpec"}}}}}}},"description":"Displays an api key.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/api_keys","x-action":"show"},"delete":{"tags":["Api Keys"],"operationId":"V1_Api_Keys-destroy","parameters":[{"name":"id","description":"Api Key ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"no content"}},"description":"Removes the api key.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/api_keys","x-action":"destroy"}},"/v1/api_keys/{id}/revoke":{"post":{"tags":["Api Keys"],"operationId":"V1_Api_Keys-revoke","parameters":[{"name":"id","description":"api key id","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update api key with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Updated api key","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApiKeySpec"}}}}}}},"description":"Revokes the api key for the user.","summary":"Revoke","security":[{"header_authorization":[]}],"x-controller":"v1/api_keys","x-action":"revoke"}},"/v1/application_categories":{"get":{"tags":["Application Categories"],"operationId":"V1_Application_Categories-index","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"200":{"description":"Application categories basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationCategorySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List extant application categories.","summary":"Get extant","security":[],"x-controller":"v1/application_categories","x-action":"index"}},"/v1/application_categories/{id}":{"get":{"tags":["Application Categories"],"operationId":"V1_Application_Categories-show","parameters":[{"name":"id","description":"Application category ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Application category basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationCategorySpec"}}}}}}},"description":"Gets basic information of a specific application category.","summary":"Show category","security":[],"x-controller":"v1/application_categories","x-action":"show"}},"/v1/applications":{"get":{"tags":["Applications"],"operationId":"V1_Applications-index","parameters":[{"name":"category_ids","description":"Category IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"200":{"description":"Applications basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List extant applications basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/applications","x-action":"index"}},"/v1/applications/all":{"get":{"tags":["Applications"],"operationId":"V1_Applications-all","parameters":[{"name":"category_ids","description":"Category IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"200":{"description":"Applications basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List applications basic information, including deleted ones.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/applications","x-action":"all"}},"/v1/applications/{id}":{"get":{"tags":["Applications"],"operationId":"V1_Applications-show","parameters":[{"name":"id","description":"Application ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Applications basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationSpec"}}}}}}},"description":"Gets basic information of a specific application.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/applications","x-action":"show"}},"/v1/billing":{"get":{"tags":["Billings"],"operationId":"V1_Billings-show","parameters":[{"name":"organization_id","description":"User organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Billing information provided by Stripe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}}}},"description":"List basic billing information of the user organization registered in Stripe platform.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/billings","x-action":"show"},"post":{"tags":["Billings"],"operationId":"V1_Billings-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not associate payment method with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content, only status `204` to indicate that the payment method was registered"}},"description":"Register a newly created payment method in database.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/billings","x-action":"create","requestBody":{"description":"Payment method information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCreate"}}}}}},"/v1/billing/address/{organization_id}":{"get":{"tags":["Billings"],"operationId":"V1_Billings-address_show","parameters":[{"name":"organization_id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Billing address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_BillingAddress"}}}}},"description":"Show the billing address for the given organization.","summary":"Show address","security":[{"header_authorization":[]}],"x-controller":"v1/billings","x-action":"address_show"},"patch":{"tags":["Billings"],"operationId":"V1_Billings-address_update","parameters":[{"name":"organization_id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update billing address with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Billing address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_BillingAddress"}}}}},"description":"Update the billing address for the given organization.","summary":"Update address","security":[{"header_authorization":[]}],"x-controller":"v1/billings","x-action":"address_update","requestBody":{"description":"Billing address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_BillingAddressUpdateSpec"}}}}}},"/v1/block_pages":{"get":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-index","parameters":[{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Block pages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockPage"}}}}}},"description":"Gets the list of block pages associated with the current user.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"index"},"post":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create block_page with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"201":{"description":"The created block page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}},"description":"Creates a new block page.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"create","requestBody":{"description":"Block page information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}}},"/v1/block_pages/all":{"get":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-all","parameters":[{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Block pages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockPage"}}}}}},"description":"Gets ALL block pages associated with the current user.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"all"}},"/v1/block_pages/{id}":{"get":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-show","parameters":[{"name":"id","description":"BlockPage ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"include_relationships","description":"Include relationships in the response true/false, defaults to true","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Block page data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}},"description":"Gets the specified block page.","summary":"Show page","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"show"},"patch":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-update","parameters":[{"name":"id","description":"BlockPage ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update block page with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Updated block page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}},"description":"Updates a block_page with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"update","requestBody":{"description":"Block page information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}},"delete":{"tags":["Block Pages"],"operationId":"V1_Block_Pages-destroy","parameters":[{"name":"id","description":"BlockPage ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The deleted block page data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockPage"}}}}},"description":"Deletes a block page.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/block_pages","x-action":"destroy"}},"/v1/categories":{"get":{"tags":["Categories"],"operationId":"V1_Categories-index","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"200":{"description":"Categories basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CategorySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List categories basic information.","summary":"Get extant","x-controller":"v1/categories","x-action":"index"}},"/v1/categories/all":{"get":{"tags":["Categories"],"operationId":"V1_Categories-all","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"200":{"description":"Categories basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CategorySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List all categories including internal categories.","summary":"Get all","x-controller":"v1/categories","x-action":"all"}},"/v1/categories/{id}":{"get":{"tags":["Categories"],"operationId":"V1_Categories-show","parameters":[{"name":"id","description":"Category ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Category basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CategorySpec"}}}}}}},"description":"Gets basic information of a specific category.","summary":"Show category","x-controller":"v1/categories","x-action":"show"}},"/v1/collections/{collection_id}/users":{"get":{"tags":["Collection Users"],"operationId":"V1_Collection_Users-index","parameters":[{"name":"collection_id","description":"Collection ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"name","description":"filter by name. If friendly_name not found, will search by user_name","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"sort","description":"Sort options, valid attributes: name","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local users information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionUserSpec"}}}}}}},"description":"Show users belonging to a specific collection with the specified id.","summary":"Gets collection users","security":[{"header_authorization":[]}],"x-controller":"v1/collection_users","x-action":"index"},"post":{"tags":["Collection Users"],"operationId":"V1_Collection_Users-create","parameters":[{"name":"collection_id","description":"Collection ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not add a user to a specified collection with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created collection basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionUserSpec"}}}}}}},"description":"Add a new user to a specific collection with the specified id.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/collection_users","x-action":"create","requestBody":{"description":"Collection information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionUserCreateSpec"}}}}}},"/v1/collections/{collection_id}/users/{id}":{"get":{"tags":["Collection Users"],"operationId":"V1_Collection_Users-show","parameters":[{"name":"collection_id","description":"The ID of the collection to search","required":true,"in":"path","schema":{"type":"integer"}},{"name":"id","description":"The ID of the user to return","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User and permission details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionUserSpec"}}}}}}},"description":"Gets the user details and permissions for the specified organization.","summary":"Show user","security":[{"header_authorization":[]}],"x-controller":"v1/collection_users","x-action":"show"},"delete":{"tags":["Collection Users"],"operationId":"V1_Collection_Users-destroy","parameters":[{"name":"collection_id","description":"The ID of the collection to search","required":true,"in":"path","schema":{"type":"integer"}},{"name":"id","description":"The ID of the user to delete","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Deletes a user from a collection.","summary":"Delete user","security":[{"header_authorization":[]}],"x-controller":"v1/collection_users","x-action":"destroy"}},"/v1/current_user":{"get":{"tags":["User (Current)"],"operationId":"V1_User_(Current)-show","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserSpec"}}}}}}},"description":"Fetch information about the currently authenticated user.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/current_users","x-action":"show"},"patch":{"tags":["User (Current)"],"operationId":"V1_User_(Current)-update","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unable to update current user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserSpec"}}}}}}},"description":"Update attributes for the currently authenticated user.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/current_users","x-action":"update","requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}}}}}}}}}},"/v1/dictionary/qp_methods":{"get":{"tags":["Dictionary Lookups"],"operationId":"V1_Dictionary_Lookups-qp_methods","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"QP Methods","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"allow":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"summary":"List QP Methods","x-controller":"v1/dictionary","x-action":"qp_methods"}},"/v1/distributors/health":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-health","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"}}}}}}},"description":"Allows testing API reachability and validation of the authentication header.\n\nNOTE: This endpoint supports the read-only pre-shared secret key.","summary":"Health Check","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"health"}},"/v1/distributors/distributors":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-distributors_index","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Distributor"}}}}},"description":"Allows to fetch basic information about a Distributor and its parent organization.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"distributors_index"},"patch":{"tags":["Distributors"],"operationId":"V1_Distributors-distributors_update","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/DistributorUpdateSpec"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to update distributor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Distributor"}}}}},"description":"Updates the specified support Distributor information.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"distributors_update"}},"/v1/distributors/msps":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_index","parameters":[{"name":"canceled_at_from","description":"Parent organization _canceled_at_ time range lower limit (inclusive). Unix timestampNote: either_include_canceled_ or _only_canceled_ must be _true_ for this filter to work","required":false,"in":"query","schema":{"type":"integer"}},{"name":"canceled_at_to","description":"Parent organization _canceled_at_ time range upper limit (inclusive). Unix timestampNote: either_include_canceled_ or _only_canceled_ must be _true_ for this filter to work","required":false,"in":"query","schema":{"type":"integer"}},{"name":"created_at_from","description":"Parent organization _created_at_ time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"created_at_to","description":"Parent organization _created_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"distributor_id","description":"Parent organization _distributor_id_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"distributor_sku","description":"Parent organization _distributor_skus_ filter. Case-sensitive exact match","required":false,"in":"query","schema":{"type":"string"}},{"name":"distributor_status","description":"Parent organization _distributor_status_ filter. Case-sensitive exact match","required":false,"in":"query","schema":{"type":"string"}},{"name":"external_id","description":"Parent organization _external_id_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"include_canceled","description":"Include canceled MSPs. Ignored if _only_canceled_ is specified (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_name","description":"MSP _name_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"only_canceled","description":"Filter by canceled MSPs only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 1500, maximum 1500).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"parent_organization_name","description":"MSP parent organization _name_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"transferred_at_from","description":"Parent organization _transferred_at_ time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"transferred_at_to","description":"Parent organization _transferred_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"trial_end","description":"Parent organization _trial_end_ filterExact match search. Date in ISO8601 format, e.g.: 2022-12-31","required":false,"in":"query","schema":{"type":"string"}},{"name":"updated_at_from","description":"Parent organization _updated_at_ time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"updated_at_to","description":"Parent organization _updated_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MspDistributor"}}}}}},"description":"Allows to get the list of MSPs that matches the search criteria.\n\nReturns all non-canceled ones by default if no search filters are\nspecified.\n\nNote: endpoint does pagination, be sure to fetch all available pages to\nget the full list.","summary":"MSP Search","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_index"},"post":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_create","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/MspDistributorCreateSpec"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Creates an MSP and its parent organization.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_create"}},"/v1/distributors/msps/{id}":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_show","parameters":[{"name":"id","description":"MSP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Allows to fetch basic information about an MSP and its parent organization.","summary":"Show MSP","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_show"},"patch":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_update","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/MspDistributorUpdateSpec"}},{"name":"id","description":"MSP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Updates the specified MSP and its parent organization data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_update"}},"/v1/distributors/msps/{id}/cancel":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_cancel","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"distributor_status":{"type":"string"}}}},{"name":"id","description":"MSP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to cancel MSP","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Cancels the specified MSP parent organization and all of its sub-organizations.","summary":"Cancel","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_cancel"}},"/v1/distributors/msps/{id}/reactivate":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_reactivate","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"distributor_status":{"type":"string"},"reactivate_sub_organizations":{"type":"boolean"}}}},{"name":"id","description":"MSP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to reactivate MSP","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Reactivates the specified MSP parent organization and all of its sub-organization if specified.","summary":"Reactivate","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_reactivate"}},"/v1/distributors/msps/{id}/upsert_skus":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-msps_upsert_skus","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"}},"remove":{"type":"array","items":{"type":"string"}}}}},{"name":"id","description":"MSP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDistributor"}}}}},"description":"Adds or removes the SKUs available to an entitlements-managed MSP post-creation.\nReturns the updated MSP. Triggers the license cascade for removed licenses.","summary":"Upsert SKUs","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"msps_upsert_skus"}},"/v1/distributors/organizations":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_index","parameters":[{"name":"canceled_at_from","description":"Organization _canceled_at_ time range lower limit (inclusive). Unix timestamp. Note: either _include_canceled_ or _only_canceled_ must be _true_ for this filter to work","required":false,"in":"query","schema":{"type":"integer"}},{"name":"canceled_at_to","description":"Organization _canceled_at_ time range upper limit (inclusive). Unix timestamp. Note: either _include_canceled_ or _only_canceled_ must be _true_ for this filter to work","required":false,"in":"query","schema":{"type":"integer"}},{"name":"created_at_from","description":"Organization _created_at_ time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"created_at_to","description":"Organization _created_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"distributor_id","description":"Organization _distributor_id_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"distributor_sku","description":"Organization _distributor_skus_ filter. Case-sensitive exact match","required":false,"in":"query","schema":{"type":"string"}},{"name":"distributor_status","description":"Organization _distributor_status_ filter. Case-sensitive exact match","required":false,"in":"query","schema":{"type":"string"}},{"name":"external_id","description":"Organization _external_id_ filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"include_canceled","description":"Include canceled organizationsIgnored if _only_canceled_ is specified (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_id","description":"Organization _msp_id/managed_by_msp_id_ filter. Exact match search. MSP parent organization is automatically excluded from the result with this filter.","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Organization _name_ filter. Case-insensitive search pattern.","required":false,"in":"query","schema":{"type":"string"}},{"name":"only_canceled","description":"Filter by canceled organizations only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 1500, maximum 1500).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"transferred_at_from","description":"Organization _transferred_at_ time range lower limit(inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"transferred_at_to","description":"Organization _transferred_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"trial_end","description":"Organization _trial_end_ filter. Exact match search. Date in ISO8601 format, e.g.: 2022-12-31","required":false,"in":"query","schema":{"type":"string"}},{"name":"updated_at_from","description":"Organization _updated_at_ time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"updated_at_to","description":"Organization _updated_at_ time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}}},"description":"Allows to get the list of organizations that matches the search criteria,\nreturns all non-canceled ones by default if no search filters are\nspecified. Note: endpoint does pagination, be sure to fetch all available\npages to get the full list.","summary":"Organizations Search","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_index"},"post":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_create","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/OrganizationDistributorCreateSpec"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Creates an MSP sub-organization.","summary":"Create suborganization","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_create"}},"/v1/distributors/organizations/{id}":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_show","parameters":[{"name":"id","description":"Scope response to id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Allows to fetch basic information about an MSP parent organization or sub-organization.","summary":"Show Organization","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_show"},"patch":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_update","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/OrganizationDistributorUpdateSpec"}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to update organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Updates the specified MSP sub-organization data.","summary":"Update suborganization","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_update"}},"/v1/distributors/organizations/{id}/cancel":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_cancel","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"distributor_status":{"type":"string"}}}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to cancel organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Cancels the specified MSP sub-organization.\n\nNote: See _Organization Cancellation_ for important details.","summary":"Cancel suborganization","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_cancel"}},"/v1/distributors/organizations/{id}/reactivate":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_reactivate","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"distributor_status":{"type":"string"}}}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to reactivate organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Reactivates the specified MSP sub-organization.\n\nNote: See _Organization Cancellation_ for important details.","summary":"Reactivate suborg","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_reactivate"}},"/v1/distributors/organizations/{id}/add_sku":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_add_sku","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"sku":{"type":"string"}}}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Helper endpoint to add a single SKU to the specified MSP parent\norganization or sub-organization instead of doing a full update that\nshould contain all SKUs.","summary":"Add Sku","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_add_sku"}},"/v1/distributors/organizations/{id}/remove_sku":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-organizations_remove_sku","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"sku":{"type":"string"}}}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDistributor"}}}}},"description":"Helper endpoint to remove a single SKU to the specified MSP parent\norganization or sub-organization instead of doing a full update that\nshould contain all SKUs.","summary":"Remove Sku","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"organizations_remove_sku"}},"/v1/distributors/users":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-users_index","parameters":[{"name":"created_at_from","description":"User created_at time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"created_at_to","description":"User created_at time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"distributor_guid","description":"User distributor_guid filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"email","description":"User email filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"first_name","description":"User first_name filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"last_name","description":"User last_name filter. Case-insensitive search pattern","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"Users with a direct membership to the parent organization of the specified MSP ID. Exact match search.","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 1500, maximum 1500).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"transferred_at_from","description":"User transferred_at time range lower limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}},{"name":"transferred_at_to","description":"User transferred_at time range upper limit (inclusive). Unix timestamp","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDistributor"}}}}}},"description":"Allows to get the list of users that matches the search criteria. Note:\nendpoint does pagination, be sure to fetch all available pages to get the\nfull list.","summary":"Users Search","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_index"},"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_create","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/UserDistributorCreateSpec"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to create user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDistributor"}}}}},"description":"Creates a new user alongside a membership with an organization.","summary":"Create user","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_create"}},"/v1/distributors/users/{id}":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-users_show","parameters":[{"name":"id","description":"Scope response to id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDistributor"}}}}},"description":"Allows to fetch basic information about an user.","summary":"Show User","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_show"}},"/v1/distributors/users/{id}/add_membership":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_add_membership","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/UserMembershipDistributorSpec"}},{"name":"id","description":"User ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to add membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDistributor"}}}}},"description":"Adds/creates a new user membership with an organization.","summary":"Add membership","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_add_membership"}},"/v1/distributors/users/{id}/update_membership":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_update_membership","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"$ref":"#/components/schemas/UserMembershipDistributorSpec"}},{"name":"id","description":"User ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to update membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDistributor"}}}}},"description":"Updates an existing user membership with an organization.","summary":"Update membership","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_update_membership"}},"/v1/distributors/users/{id}/remove_membership":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_remove_membership","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"organization_id":{"type":"integer"}}}},{"name":"id","description":"User ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to remove membership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDistributor"}}}}},"description":"Removes/deletes an existing user membership with an organization.","summary":"Remove membership","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_remove_membership"}},"/v1/distributors/users/{id}/send_reset_password_email":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_send_reset_password_email","parameters":[{"name":"id","description":"Scope response to id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failure to generate reset password email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"Email sent"}},"description":"Sends a reset password email to the specified user.","summary":"Reset password","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_send_reset_password_email"}},"/v1/distributors/users/{id}/reset_password_url":{"post":{"tags":["Distributors"],"operationId":"V1_Distributors-users_reset_password_url","parameters":[{"name":"id","description":"Scope response to id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reset_password_url":{"type":"string"}}}}}}},"description":"Creates a new reset password URL for the specified user.\n\nThe URL is valid for 432000 seconds (5 days).","summary":"Reset password URL","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"users_reset_password_url"}},"/v1/distributors/reports/usage_by_organization":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-reports_usage_by_organization","parameters":[{"name":"date","description":"Report date.  Date in ISO8601 format, e.g.: 2022-12-31","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"include_in_trial","description":"Includes organizations that were in trial in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"include_parent_organization","description":"Includes MSPs parent organizations in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_ids","description":"List of MSP IDs, e.g.: 1,2,3","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_ids","description":"List of organization IDs, e.g.: 4,5,6","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK"}},"description":"Allows to fetch user usage information per organization.\nNOTE: This endpoint supports the read-only pre-shared secret key.","summary":"Get usage info","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"reports_usage_by_organization"}},"/v1/distributors/reports/usage_by_sku":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-reports_usage_by_sku","parameters":[{"name":"date","description":"Report date.  Date in ISO8601 format, e.g.: 2022-12-31","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"include_in_trial","description":"Includes organizations that were in trial in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"include_parent_organization","description":"Includes MSPs parent organizations in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_ids","description":"List of MSP IDs, e.g.: 1,2,3","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_ids","description":"List of organization IDs, e.g.: 4,5,6","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK"}},"description":"Allows to fetch user usage information per SKU.\n\nNOTE: it might be possible that the covered_users and estimated_users\nvalues do not match the total_requests / 6000 math, since these values\nare the sum of already rounded up values of organizations with the given\nSKU.\n\nNOTE: This endpoint supports the read-only pre-shared secret key.","summary":"Get usage info by SKU","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"reports_usage_by_sku"}},"/v1/distributors/reports/covered_users_summary_by_organization":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-reports_covered_users_summary_by_organization","parameters":[{"name":"from","description":"Report range lower limit. Date in ISO8601 format, e.g.: 2022-12-01","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"include_in_trial","description":"Includes organizations that were in trial in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"include_parent_organization","description":"Includes MSPs parent organizations in the result (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_ids","description":"List of MSP IDs, e.g.: 1,2,3","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_ids","description":"List of organization IDs, e.g.: 4,5,6","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"to","description":"Report range upper limit. Date in ISO8601 format, e.g.: 2022-12-31","required":true,"in":"query","schema":{"type":"string","format":"date"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Invalid distributor or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK"}},"description":"Allows to fetch covered users information by organization for the given\ndate range.\n\nMaximum days in date range is limited to 31.\n\nNOTE: This endpoint supports the read-only pre-shared secret key.","summary":"Get user info by date","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"reports_covered_users_summary_by_organization"}},"/v1/distributors/skus_available":{"get":{"tags":["Distributors"],"operationId":"V1_Distributors-skus_available","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"skus":{"type":"array","items":{"type":"string"}}}}}}}},"description":"Returns the list of SKUs available to the distributor's customers.","summary":"SKUs","security":[{"header_authorization":[]}],"x-controller":"v1/distributors","x-action":"skus_available"}},"/v1/notes/{resource}/{id}/{domain}":{"get":{"tags":["Domain Notes"],"operationId":"V1_Domain_Notes-show","parameters":[{"name":"domain","description":"domain","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","description":"Resource ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"resource","description":"Valid resources: policies, msps or organizations","required":true,"in":"path","schema":{"type":"string","enum":["policies","msps","organizations"]}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Resource notes information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DomainNotesSpec"}}}}}},"description":"Gets associated notes from a specific resource.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/domain_notes","x-action":"show"},"patch":{"tags":["Domain Notes"],"operationId":"V1_Domain_Notes-update","parameters":[{"name":"domain","description":"domain","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","description":"Resource ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"resource","description":"Valid resources: policies, msps or organizations","required":true,"in":"path","schema":{"type":"string","enum":["policies","msps","organizations"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update resource notes with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Resource notes information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DomainNotesSpec"}}}}}},"description":"Updates notes for a resource with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/domain_notes","x-action":"update","requestBody":{"description":"Resource notes information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainNotesCreateSpec"}}}}}},"/v1/notes/{resource}/{id}/batch_update":{"patch":{"tags":["Domain Notes"],"operationId":"V1_Domain_Notes-batch_update","parameters":[{"name":"append","description":"true/false if the domains and notes are appended or updated, false by default.","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"id","description":"Resource ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"notes","description":"Array with domain and notes information. ie: notes: [domain: 'google.com', note: 'google notes']","required":true,"in":"query","schema":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"note":{"type":"string"}}}},"explode":true},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"resource","description":"Valid resources: policies, msps or organizations","required":true,"in":"path","schema":{"type":"string","enum":["policies","msps","organizations"]}},{"name":"single_note","description":"a note applied for all provided domains","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of list allowlist/blocklist (allow, block), defaults to allow","required":false,"in":"query","schema":{"type":"string","enum":["allow","block"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update resource notes with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Resource notes information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DomainNotesSpec"}}}}}},"description":"Updates notes for a resource with the specified data.","summary":"Bulk update","security":[{"header_authorization":[]}],"x-controller":"v1/domain_notes","x-action":"batch_update"}},"/v1/notes/{resource}/{id}/notes/{domain}":{"delete":{"tags":["Domain Notes"],"operationId":"V1_Domain_Notes-destroy","parameters":[{"name":"domain","description":"domain","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","description":"Resource ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"resource","description":"Valid resources: policies, msps or organizations","required":true,"in":"path","schema":{"type":"string","enum":["policies","msps","organizations"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete resource notes","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Resource notes information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DomainNotesSpec"}}}}}},"description":"Deletes notes for a resource.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/domain_notes","x-action":"destroy"}},"/v1/notes/{resource}/{id}/notes/batch_destroy":{"delete":{"tags":["Domain Notes"],"operationId":"V1_Domain_Notes-batch_destroy","parameters":[{"name":"domains","description":"Comma separated list of domains.","required":true,"in":"query","schema":{"type":"string"}},{"name":"id","description":"Resource ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"resource","description":"Valid resources: policies, msps or organizations","required":true,"in":"path","schema":{"type":"string","enum":["policies","msps","organizations"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete resource notes","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Resource notes information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DomainNotesSpec"}}}}}},"description":"Deletes notes for a resource.","summary":"Batch destroy","security":[{"header_authorization":[]}],"x-controller":"v1/domain_notes","x-action":"batch_destroy"}},"/v1/domains/user_lookup":{"get":{"tags":["Domains"],"operationId":"V1_Domains-user_lookup","parameters":[{"name":"fqdn","description":"FQDN to lookup","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Domains basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DomainSpec"}}}}}}},"description":"Gets all the domains associated for a particular FQDN.","summary":"Lookup","security":[{"header_authorization":[]}],"x-controller":"v1/domains","x-action":"user_lookup"}},"/v1/domains/bulk_lookup":{"get":{"tags":["Domains"],"operationId":"V1_Domains-bulk_lookup","parameters":[{"name":"fqdns","description":"Comma separated list of FQDNs to lookup","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Domains basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DomainSpec"}}}}}}}},"description":"Gets the domains and categories associated for each FQDN of the specified list.","summary":"Bulk lookup","security":[{"header_authorization":[]}],"x-controller":"v1/domains","x-action":"bulk_lookup"}},"/v1/domains/suggest_threat":{"post":{"tags":["Domains"],"operationId":"V1_Domains-suggest_threat","parameters":[{"name":"categories","description":"Suggested security categories, comma separated IDs","required":false,"in":"query","schema":{"type":"string"}},{"name":"fqdn","description":"FQDN to verify","required":true,"in":"query","schema":{"type":"string"}},{"name":"notes","description":"User notes about the threat suggestion/verification","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Operation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Success"}}}}},"description":"Mark a FQDN to verify its threat categorization.\n\nRequest example: `/v1/domains/suggest_threat?fqdn=XXXX\u0026notes\u0026test-report\u0026categories=1,222,989`","summary":"Suggest threat","security":[{"header_authorization":[]}],"x-controller":"v1/domains","x-action":"suggest_threat"}},"/v1/enterprise_connections":{"get":{"tags":["Enterprise Connections"],"operationId":"V1_Enterprise_Connections-index","parameters":[{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Array of enterprise connections","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/EnterpriseConnection"}}}}}}}}}},"description":"Gets information for all the enterprise connections for the given organization.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/enterprise_connections","x-action":"index"},"post":{"tags":["Enterprise Connections"],"operationId":"V1_Enterprise_Connections-create","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unable to create connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Enterprise connection","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/EnterpriseConnection"}}}}}}}}},"description":"Create an enterprise connection.\n\nNote: To set your organization's custom login url for enterprise\nconnections, you need to set the 'unique_id' attribute on the\norganization itself. See the PATCH /v1/organizations endpoint.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/enterprise_connections","x-action":"create","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseConnectionCreatePayload"}}}}}},"/v1/enterprise_connections/{id}":{"get":{"tags":["Enterprise Connections"],"operationId":"V1_Enterprise_Connections-show","parameters":[{"name":"id","description":"Enterprise connection ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Enterprise connection","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/EnterpriseConnection"}}}}}}}}},"description":"Gets information for the specified enterprise connection.","summary":"Show connection","security":[{"header_authorization":[]}],"x-controller":"v1/enterprise_connections","x-action":"show"},"patch":{"tags":["Enterprise Connections"],"operationId":"V1_Enterprise_Connections-update","parameters":[{"name":"id","description":"Enterprise connection ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unable to update connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Enterprise connection","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/EnterpriseConnection"}}}}}}}}},"description":"Update an enterprise connection.\n\nNote: To set your organization's custom login url for enterprise\nconnections, you need to set the 'unique_id' attribute on the\norganization itself. See the PATCH /v1/organizations endpoint.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/enterprise_connections","x-action":"update","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseConnectionUpdatePayload"}}}}},"delete":{"tags":["Enterprise Connections"],"operationId":"V1_Enterprise_Connections-destroy","parameters":[{"name":"id","description":"Enterprise connection ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unable to delete connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Delete an enterprise connection.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/enterprise_connections","x-action":"destroy"}},"/v1/invoices/current":{"get":{"tags":["Invoices"],"operationId":"V1_Invoices-current","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Estimated invoice for next month\n`WARNING`: almost all invoice data are `null` values, take that into consideration when using this endpoint","content":{"application/json":{"schema":{"type":"object","properties":{"month_to_date":{"$ref":"#/components/schemas/Invoice"},"estimated":{"$ref":"#/components/schemas/Invoice"}}}}}}},"description":"Gets user estimated invoice for next month.","summary":"Get current invoice","security":[{"header_authorization":[]}],"x-controller":"v1/invoices","x-action":"current"}},"/v1/invoices":{"get":{"tags":["Invoices"],"operationId":"V1_Invoices-index","parameters":[{"name":"organization_id","description":"User organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Invoices basic information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}},"description":"Gets user associated invoices, most recent first.","summary":"Get invoices","security":[{"header_authorization":[]}],"x-controller":"v1/invoices","x-action":"index"}},"/v1/invoices/{id}":{"get":{"tags":["Invoices"],"operationId":"V1_Invoices-show","parameters":[{"name":"id","description":"Invoice ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"organization_id","description":"User organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Invoice basic information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}}},"description":"Gets basic information of the specified invoice.","summary":"Get invoice","security":[{"header_authorization":[]}],"x-controller":"v1/invoices","x-action":"show"}},"/v1/ip_addresses":{"get":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-index","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"search","description":"Search specific IP information","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"IP addresses basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets user associated IP addresses basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"index"},"post":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create IP address with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created IP address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IpAddressSpec"}}}}}}},"description":"Creates a new IP address with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"create","requestBody":{"description":"IP address information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpAddressCreateSpec"}}}}}},"/v1/ip_addresses/all":{"get":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-all","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"IP addresses basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL user associated IP addresses basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"all"}},"/v1/ip_addresses/{id}":{"get":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-show","parameters":[{"name":"id","description":"IP address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"IP address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IpAddressSpec"}}}}}}},"description":"Gets basic information of the specified IP address.","summary":"Show IP","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"show"},"patch":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-update","parameters":[{"name":"id","description":"IP address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update IP address with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated IP address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IpAddressSpec"}}}}}}},"description":"Updates an IP address with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"update","requestBody":{"description":"IP address information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpAddressCreateSpec"}}}}},"delete":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-destroy","parameters":[{"name":"id","description":"IP address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Removed IP address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IpAddressSpec"}}}}}}},"description":"Removes an IP address.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"destroy"}},"/v1/ip_addresses/verify":{"get":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-verify","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"JSON string that contains the non conflict confirmation message or IP address basic info if already exists in the system","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string"}}},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}}}}]}}}}},"description":"Verification call to ensure IP address is not already in the system.","summary":"Verify IP","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"verify","requestBody":{"description":"IP address information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpAddressCreateSpec"}}}}}},"/v1/ip_addresses/myip":{"get":{"tags":["IP Addresses"],"operationId":"V1_IP_Addresses-myip","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"JSON string that contains the IP address","content":{"application/json":{"schema":{"type":"object","properties":{"myip":{"type":"string"}}}}}}},"description":"Responds with the requester reported IP address.","summary":"Get my IP","security":[{"header_authorization":[]}],"x-controller":"v1/ip_addresses","x-action":"myip"}},"/v1/mac_addresses":{"get":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-index","parameters":[{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"MAC addresses basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MacAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets the MAC addresses associated to an organization with basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"index"},"post":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create the MAC address with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created MAC address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MacAddressSpec"}}}}}}},"description":"Creates a new MAC address with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"create","requestBody":{"description":"MAC address information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacAddressCreateSpec"}}}}}},"/v1/mac_addresses/all":{"get":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-all","parameters":[{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"MAC addresses basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MacAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL MAC addresses associated to an user with basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"all"}},"/v1/mac_addresses/{id}":{"get":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-show","parameters":[{"name":"id","description":"MAC address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"MAC address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MacAddressSpec"}}}}}}},"description":"Gets basic information of the specified MAC address.","summary":"Show address","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"show"},"patch":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-update","parameters":[{"name":"id","description":"MAC address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update MAC address with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated MAC address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MacAddressSpec"}}}}}}},"description":"Updates a MAC address with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"update","requestBody":{"description":"MAC address information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacAddressCreateSpec"}}}}},"delete":{"tags":["MAC Addresses"],"operationId":"V1_MAC_Addresses-destroy","parameters":[{"name":"id","description":"MAC address ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Removed MAC address basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MacAddressSpec"}}}}}}},"description":"Deletes a MAC address.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/mac_addresses","x-action":"destroy"}},"/v1/metrics/organization_usage/{id}":{"get":{"tags":["Metrics"],"operationId":"V1_Metrics-organization_usage","parameters":[{"name":"from","description":"Date in IS08601 format, ex: \"2023-12-01\"","required":true,"in":"query","schema":{"type":"string","format":"date"}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"to","description":"Date in IS08601 format, ex: \"2023-12-01\".","required":true,"in":"query","schema":{"type":"string","format":"date"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"JSON formatted result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"organization_id":{"type":"integer"},"plan":{"type":"string"},"term":{"type":"string"},"user_count":{"type":"integer"},"wifi_count":{"type":"integer"},"total_requests":{"type":"integer"},"estimated_users":{"type":"integer"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"days_in_period":{"type":"integer"}}},"meta":{"type":"object","properties":{"queries_per_user":{"type":"integer"}}}}}}}}},"description":"Gets usage information for the given Organization over the given date\nrange. Maximum date range is 365 days.","summary":"Get usage","security":[{"header_authorization":[]}],"x-controller":"v1/metrics","x-action":"organization_usage"}},"/v1/metrics/organization_usage_detailed/{id}":{"get":{"tags":["Metrics"],"operationId":"V1_Metrics-organization_usage_detailed","parameters":[{"name":"from","description":"Date in IS08601 format, ex: \"2023-12-01\"","required":false,"in":"query","schema":{"type":"string","format":"date"}},{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"to","description":"Date in IS08601 format, ex: \"2023-12-01\".","required":false,"in":"query","schema":{"type":"string","format":"date"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"JSON formatted result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"organization_id":{"type":"integer"},"plan":{"type":"string"},"term":{"type":"string"},"user_count":{"type":"integer"},"wifi_count":{"type":"integer"},"roaming_client_count":{"type":"integer"},"mobile_roaming_client_count":{"type":"integer"},"total_requests":{"type":"integer"},"estimated_users":{"type":"integer"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"days_in_period":{"type":"integer"}}},"meta":{"type":"object","properties":{"queries_per_user":{"type":"integer"}}}}}}}}},"description":"Gets usage information for the given organization.\n\nThis differs from +organization_usage+ in the way +user_count+/+wifi_count+ are fetched from the DB,\nalso these endpoints returns a roaming client count.","summary":"Get usage detailed","security":[{"header_authorization":[]}],"x-controller":"v1/metrics","x-action":"organization_usage_detailed"}},"/v1/networks/{id}/lan_ips":{"get":{"tags":["Network LAN IPs"],"operationId":"V1_Network_LAN_IPs-index","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"LAN IPs basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkLanIpSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets network associated LAN IPs with basic information.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/network_lan_ips","x-action":"index"}},"/v1/networks/{id}/lan_ips/{lan_ip_id}":{"get":{"tags":["Network LAN IPs"],"operationId":"V1_Network_LAN_IPs-show","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"lan_ip_id","description":"LAN IP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"LAN IP basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkLanIpSpec"}}}}}}},"description":"Gets network associated LAN IP with basic information.","summary":"Show Lan IP","security":[{"header_authorization":[]}],"x-controller":"v1/network_lan_ips","x-action":"show"},"patch":{"tags":["Network LAN IPs"],"operationId":"V1_Network_LAN_IPs-update","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"lan_ip_id","description":"LAN IP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update LAN IP with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"LAN IP basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkLanIpSpec"}}}}}}},"description":"Updates a network LAN IP with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/network_lan_ips","x-action":"update","requestBody":{"description":"LAN IP information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkLanIpUpdateSpec"}}}}}},"/v1/networks/subnets":{"get":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-all","parameters":[{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Subnets basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSubnetSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"List site subnets with basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"all"}},"/v1/networks/{id}/subnets":{"get":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-index","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Subnets basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSubnetSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets network associated subnets with basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"index"},"post":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-create","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update subnet with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Subnet basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSubnetSpec"}}}}}}},"description":"Creates a network subnet with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"create","requestBody":{"description":"Subnet information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSubnetCreateSpec"}}}}}},"/v1/networks/{id}/subnets/{subnet_id}":{"get":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-show","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"subnet_id","description":"Subnet ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Subnet basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSubnetSpec"}}}}}}},"description":"Gets network associated subnet with basic information.","summary":"Show subnet","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"show"},"patch":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-update","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"subnet_id","description":"Subnet ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update subnet with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Subnet basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSubnetSpec"}}}}}}},"description":"Updates a network subnet with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"update","requestBody":{"description":"Subnet information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSubnetCreateSpec"}}}}},"delete":{"tags":["Network Subnets"],"operationId":"V1_Network_Subnets-destroy","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"subnet_id","description":"Subnet ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not destroy subnet with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Deleted subnet basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSubnetSpec"}}}}}}},"description":"Deletes a network subnet with the specified data.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/network_subnets","x-action":"destroy"}},"/v1/networks":{"get":{"tags":["Networks"],"operationId":"V1_Networks-index","parameters":[{"name":"basic_info","description":"Return most basic Network Info only. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"count_network_ips","description":"Return count of IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"force_truncate_ips","description":"Return Network info without IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"protected","description":"Filter networks with assigned policy","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"search","description":"Search for the given value among the network name, hostname, ip address, etc.","required":false,"in":"query","schema":{"type":"string"}},{"name":"unprotected","description":"Filter networks without assigned policy","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSpec"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets user's associated networks with basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"index"},"post":{"tags":["Networks"],"operationId":"V1_Networks-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create network with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created network basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Creates a new network with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"create","requestBody":{"description":"Network information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkCreateSpec"}}}}}},"/v1/networks/all":{"get":{"tags":["Networks"],"operationId":"V1_Networks-all","parameters":[{"name":"basic_info","description":"Return most basic Network Info only. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"count_network_ips","description":"Return count of IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"force_truncate_ips","description":"Return Network info without IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"protected","description":"Filter networks with assigned policy","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"search","description":"Search for the given value among the network name, hostname, ip address, etc.","required":false,"in":"query","schema":{"type":"string"}},{"name":"unprotected","description":"Filter networks without assigned policy","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSpec"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL networks associated to the user with its basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"all"}},"/v1/networks/counts":{"get":{"tags":["Networks"],"operationId":"V1_Networks-counts","parameters":[{"name":"msp_id","description":"MSP ID, will get info for all suborgs","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Network counts information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkCounts"}}}}},"description":"Gets counts of networks for each network status.","summary":"Counts","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"counts"}},"/v1/networks/msp":{"get":{"tags":["Networks"],"operationId":"V1_Networks-msp","parameters":[{"name":"basic_info","description":"Return most basic Network Info only. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"count_network_ips","description":"Return count of IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"force_truncate_ips","description":"Return Network info without IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"protected","description":"Filter networks with assigned policy","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"unprotected","description":"Filter networks without assigned policy","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSpec"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets MSP user associated networks with basic information.","summary":"Get extant MSP","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"msp"}},"/v1/networks/msp/all":{"get":{"tags":["Networks"],"operationId":"V1_Networks-msp_all","parameters":[{"name":"count_network_ips","description":"Return count of IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"force_truncate_ips","description":"Return Network info without IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"protected","description":"Filter networks with assigned policy","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"unprotected","description":"Filter networks without assigned policy","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSpec"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL networks associated to the MSP user with its basic information.","summary":"Get all MSP","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"msp_all"}},"/v1/networks/geo":{"get":{"tags":["Networks"],"operationId":"V1_Networks-geo","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks geo information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkGeo"}}}}}},"description":"Gets user's associated networks with geo information only.","summary":"Get Geo","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"geo"}},"/v1/networks/lookup":{"get":{"tags":["Networks"],"operationId":"V1_Networks-lookup","parameters":[{"name":"requesting_ip_address","description":"IP address to lookup","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Lookup network basic information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkLookup"}}}}},"description":"Gets basic information of a network based on its associated IP addresses.","summary":"Get by IP","security":[],"x-controller":"v1/networks","x-action":"lookup"}},"/v1/networks/{id}":{"get":{"tags":["Networks"],"operationId":"V1_Networks-show","parameters":[{"name":"count_network_ips","description":"Return count of IP Addresses. Defaults to False","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Networks basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Gets basic information of the specified network.","summary":"Show network","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"show"},"patch":{"tags":["Networks"],"operationId":"V1_Networks-update","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update network with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated network basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Updates a network with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"update","requestBody":{"description":"Network information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkUpdateSpec"}}}}},"delete":{"tags":["Networks"],"operationId":"V1_Networks-destroy","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Network has active user agents or LAN proxies associated and cannot be deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete network","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Deletes a network.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"destroy"}},"/v1/networks/bulk_create":{"post":{"tags":["Networks"],"operationId":"V1_Networks-bulk_create","parameters":[{"name":"Network","description":"information","required":false,"in":"query","schema":{"type":"object","properties":{"networks":{"type":"array","items":{"$ref":"#/components/schemas/NetworkCreateSpec"}}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failed to create networks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}},"description":"Bulk create multiple networks with the specified data.","summary":"Bulk create","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_create"}},"/v1/networks/bulk_create/{id}":{"get":{"tags":["Networks"],"operationId":"V1_Networks-bulk_create_status","parameters":[{"name":"id","description":"The ID of the bulk create job to check status on","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"skipped":{"type":"integer"},"failed_ids":{"type":"string"},"skipped_ids":{"type":"string"},"done":{"type":"boolean"}}}}}}},"description":"Bulk create status.","summary":"Bulk create status","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_create_status"}},"/v1/networks/bulk_update":{"post":{"tags":["Networks"],"operationId":"V1_Networks-bulk_update","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failed to update networks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}},"description":"Bulk update multiple networks with the specified data.","summary":"Bulk update","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_update","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkBulkUpdateSpec"}}}}}},"/v1/networks/bulk_update/{id}":{"get":{"tags":["Networks"],"operationId":"V1_Networks-bulk_update_status","parameters":[{"name":"id","description":"The ID of the bulk update job to check status on","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"skipped":{"type":"integer"},"failed_ids":{"type":"string"},"skipped_ids":{"type":"string"},"done":{"type":"boolean"}}}}}}},"summary":"Bulk update status","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_update_status"}},"/v1/networks/bulk_destroy":{"delete":{"tags":["Networks"],"operationId":"V1_Networks-bulk_destroy","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}},"description":"Bulk destroy multiple networks.","summary":"Bulk Delete","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_destroy","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkBulkDestroySpec"}}}}}},"/v1/networks/bulk_destroy/{id}":{"get":{"tags":["Networks"],"operationId":"V1_Networks-bulk_destroy_status","parameters":[{"name":"id","description":"The ID of the bulk update job to check status on","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"successful":{"type":"integer"},"failed":{"type":"integer"},"skipped":{"type":"integer"},"failed_ids":{"type":"string"},"skipped_ids":{"type":"string"},"done":{"type":"boolean"}}}}}}},"description":"Bulk destroy status.","summary":"Bulk delete status","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"bulk_destroy_status"}},"/v1/networks/{id}/secret_key":{"post":{"tags":["Networks"],"operationId":"V1_Networks-generate_secret_key","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create secret key","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated network basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Creates a new network secret key to be used by agents.","summary":"Create Key","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"generate_secret_key"},"delete":{"tags":["Networks"],"operationId":"V1_Networks-revoke_secret_key","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not revoke secret key","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated network basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Revokes a network secret key.","summary":"Delete Key","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"revoke_secret_key"},"patch":{"tags":["Networks"],"operationId":"V1_Networks-rotate_secret_key","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create secret key","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated network basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkSpec"}}}}}}},"description":"Rotates (renew) a network secret key to be used by agents.","summary":"Rotate key","security":[{"header_authorization":[]}],"x-controller":"v1/networks","x-action":"rotate_secret_key"}},"/v1/organizations/{organization_id}/users":{"get":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-index","parameters":[{"name":"include_auth_providers","description":"Return user's authentication providers if true (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"The ID of the organization to search","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User and permission details","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationUser"}}}}}}}},"description":"Gets the users for the specified organization.","summary":"Get"},"post":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-create","parameters":[{"name":"organization_id","description":"The ID of the organization","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update user with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"The new user and role information","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/OrganizationUser"}}}}}}},"description":"Adds a new or existing user with the specified email to the specified\norganization.","summary":"Create","requestBody":{"description":"User information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUserCreateSpec"}}}}}},"/v1/organizations/{organization_id}/users/{id}":{"get":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-show","parameters":[{"name":"id","description":"The ID of the user to return","required":true,"in":"path","schema":{"type":"integer"}},{"name":"include_auth_providers","description":"Return user's authentication providers if true (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"The ID of the organization to search","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User and permission details","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/OrganizationUser"}}}}}}},"description":"Gets the user details and permissions for the specified organization.","summary":"Show user"},"patch":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-update","parameters":[{"name":"id","description":"The OrganizationUser ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"organization_id","description":"The ID of the organization to search","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update user with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated user and role information","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/OrganizationUser"}}}}}}},"description":"Updates a user or permissions with the specified data.","summary":"Update","requestBody":{"description":"User information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUserCreateSpec"}}}}},"delete":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-destroy","parameters":[{"name":"id","description":"Network ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"organization_id","description":"The ID of the organization to search","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Removes a user from the organization. This will not actually delete the\nuser account.","summary":"Delete"}},"/v1/organizations/{organization_id}/users/{id}/resend_invite":{"post":{"tags":["Organization Users"],"operationId":"V1_Organization_Users-resend_invite","parameters":[{"name":"id","description":"The ID of the user","required":true,"in":"path","schema":{"type":"integer"}},{"name":"organization_id","description":"The ID of the organization","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Resends the user invite for the specified user and organization.","summary":"Resend Invite"}},"/v1/organizations":{"get":{"tags":["Organizations"],"operationId":"V1_Organizations-index","parameters":[{"name":"basic_info","description":"just return organizations basic info true/false, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"exclude_inherit_privacy_mode","description":"Exclude organizations that have inherit privacy mode","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"managed_by_msp_id","description":"MSPs sub-organizations whose MSP ID matches this value","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Filter by organization name","required":false,"in":"query","schema":{"type":"string"}},{"name":"owned_msp_id","description":"Parent organizations whose MSP ID matches this value","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"pii_grid_search","description":"Filter by organization name or privacy mode for pii grid search","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Filter by organization type","required":false,"in":"query","schema":{"type":"string","enum":["normal","msp","sub_organization"]}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organizations basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets user's associated organizations basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"index"},"post":{"tags":["Organizations"],"operationId":"V1_Organizations-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create organization with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created organization basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSpec"}}}}}}},"description":"Creates a new organization with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"create","requestBody":{"description":"Organization information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreateSpec"}}}}}},"/v1/organizations/all":{"get":{"tags":["Organizations"],"operationId":"V1_Organizations-all","parameters":[{"name":"basic_info","description":"just return organizations basic info true/false, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"managed_by_msp_id","description":"MSPs sub-organizations whose MSP ID matches this value","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Filter by organization name","required":false,"in":"query","schema":{"type":"string"}},{"name":"owned_msp_id","description":"Parent organizations whose MSP ID matches this value","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"type","description":"Filter by organization type","required":false,"in":"query","schema":{"type":"string","enum":["normal","msp","sub_organization"]}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organizations basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets all organizations basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"all"}},"/v1/organizations/{id}":{"get":{"tags":["Organizations"],"operationId":"V1_Organizations-show","parameters":[{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"include_current_mrr","description":"Optionally Include current MRR information","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organization basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSpec"}}}}}}},"description":"Gets basic information of the specified organization.","summary":"Show organization","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"show"},"patch":{"tags":["Organizations"],"operationId":"V1_Organizations-update","parameters":[{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update organization with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated organization basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSpec"}}}}}}},"description":"Updates an organization with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"update","requestBody":{"description":"Organization information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreateSpec"}}}}},"delete":{"tags":["Organizations"],"operationId":"V1_Organizations-destroy","parameters":[{"name":"clear_subscription_info","description":"Clears subscription information tied to the customer, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"id","description":"MSP customer ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete the MSP customer or invalid customer ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Deletes an MSP customer.","summary":"Delete MSP","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"destroy"}},"/v1/organizations/settings":{"get":{"tags":["Organizations"],"operationId":"V1_Organizations-settings","parameters":[{"name":"msp_id","description":"MSP ID to set scope","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Filter by organization name","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID to set scope","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Multiple organization IDs to set scope","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organization basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSpec"}}}}}}},"description":"Gets basic information of the specified organization.","summary":"Get settings","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"settings"}},"/v1/organizations/bulk_update":{"patch":{"tags":["Organizations"],"operationId":"V1_Organizations-bulk_update","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Failed to update one or more organizations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"A +success+ flag indicating bulk update was successful","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"description":"Updates one or more organizations with the specified data.","summary":"Bulk update","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"bulk_update","requestBody":{"description":"Organization information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBulkUpdate"}}}}}},"/v1/organizations/{id}/cancel":{"post":{"tags":["Organizations"],"operationId":"V1_Organizations-cancel","parameters":[{"name":"id","description":"Organization ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not cancel the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Sets an organization as 'Canceled'.","summary":"Cancel","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"cancel"}},"/v1/organizations/promote_to_msp":{"post":{"tags":["Organizations"],"operationId":"V1_Organizations-promote_to_msp","parameters":[{"name":"plan","description":"Plan name, valid attributes: manual, tier1, tier2, tier3, friendly_wifi","required":false,"in":"query","schema":{"type":"string"}},{"name":"zapier_params","description":"info that are sent to zapier after promoting successfully a MSP. iex { querystring__org_id: 1111, querystring__user_id: 2222 }","required":false,"in":"query","schema":{"type":"object"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"User owned organization is cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organization info","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"Promote an organization to a MSP.","summary":"Promote","security":[{"header_authorization":[]}],"x-controller":"v1/organizations","x-action":"promote_to_msp"}},"/v1/policies/bulk/add_allowlist_domains":{"post":{"tags":["Policies Bulk Actions"],"operationId":"V1_Policies_Bulk_Actions-add_allowlist_domains","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionsListDomainsResponse"}}}}},"description":"Adds one or more domains to one or more policy's allow list.","summary":"Bulk add allow","security":[{"header_authorization":[]}],"x-controller":"v1/policies_bulk_actions","x-action":"add_allowlist_domains","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionListDomains"}}}}}},"/v1/policies/bulk/remove_allowlist_domains":{"post":{"tags":["Policies Bulk Actions"],"operationId":"V1_Policies_Bulk_Actions-remove_allowlist_domains","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionsListDomainsResponse"}}}}},"description":"Removes one or more domains from one or more policy's allow list.","summary":"Bulk delete allow","security":[{"header_authorization":[]}],"x-controller":"v1/policies_bulk_actions","x-action":"remove_allowlist_domains","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionListDomains"}}}}}},"/v1/policies/bulk/add_blocklist_domains":{"post":{"tags":["Policies Bulk Actions"],"operationId":"V1_Policies_Bulk_Actions-add_blocklist_domains","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionsListDomainsResponse"}}}}},"description":"Adds one or more domains to one or more policy's block list.","summary":"Bulk add block","security":[{"header_authorization":[]}],"x-controller":"v1/policies_bulk_actions","x-action":"add_blocklist_domains","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionListDomains"}}}}}},"/v1/policies/bulk/remove_blocklist_domains":{"post":{"tags":["Policies Bulk Actions"],"operationId":"V1_Policies_Bulk_Actions-remove_blocklist_domains","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionsListDomainsResponse"}}}}},"description":"Removes one or more domains from one or more policy's block list.","summary":"Bulk delete block","security":[{"header_authorization":[]}],"x-controller":"v1/policies_bulk_actions","x-action":"remove_blocklist_domains","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionListDomains"}}}}}},"/v1/policies":{"get":{"tags":["Policies"],"operationId":"V1_Policies-index","parameters":[{"name":"include_global_policies","description":"include global policies to listing","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Policies basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PolicySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets user associated policies basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"index"},"post":{"tags":["Policies"],"operationId":"V1_Policies-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"201":{"description":"Created policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Creates a new policy with the specified data.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"create","requestBody":{"description":"Policy information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCreateSpec"}}}}}},"/v1/policies/all":{"get":{"tags":["Policies"],"operationId":"V1_Policies-all","parameters":[{"name":"include_global_policies","description":"include global policies to listing","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Policies basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PolicySpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL user associated policies basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"all"}},"/v1/policies/{id}":{"get":{"tags":["Policies"],"operationId":"V1_Policies-show","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"include_relationships","description":"Include relationships in the response true/false, defaults to true","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Gets basic information of the specified policy.","summary":"Show policy","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"show"},"patch":{"tags":["Policies"],"operationId":"V1_Policies-update","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Updates a policy with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"update","requestBody":{"description":"Policy information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCreateSpec"}}}}},"delete":{"tags":["Policies"],"operationId":"V1_Policies-destroy","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Deletes a policy.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"destroy"}},"/v1/policies/application":{"get":{"tags":["Policies"],"operationId":"V1_Policies-application","parameters":[{"name":"application_id","description":"Application ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Name or partial name of a policy to query","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"policy_ids","description":"List of Policy IDs","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyApplicationSpec"}}}}}}},"description":"Gets policies information for a specific application.","summary":"Get application","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"application"}},"/v1/policies/application_update":{"post":{"tags":["Policies"],"operationId":"V1_Policies-application_update","parameters":[{"name":"allow_policies","description":"List of Policy IDs to be allowed on an specific application","required":true,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"application_id","description":"Application ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"block_policies","description":"List of Policy IDs to be blocked on an specific application","required":true,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyApplicationSpec"}}}}}}},"description":"Updates a policy with the specified application data.","summary":"Update application","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"application_update"}},"/v1/policies/{id}/add_blacklist_domain":{"post":{"tags":["Policies"],"operationId":"V1_Policies-add_blacklist_domain","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Adds a single domain to the blocklist.","summary":"Add block domain","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"add_blacklist_domain","requestBody":{"description":"Domain to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleDomainSpec"}}}}}},"/v1/policies/{id}/remove_blacklist_domain":{"post":{"tags":["Policies"],"operationId":"V1_Policies-remove_blacklist_domain","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Removes a single domain from the blocklist.","summary":"Remove block domain","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"remove_blacklist_domain","requestBody":{"description":"Domain to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleDomainSpec"}}}}}},"/v1/policies/{id}/add_whitelist_domain":{"post":{"tags":["Policies"],"operationId":"V1_Policies-add_whitelist_domain","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Adds a single domain to the allowlist.","summary":"Add allow domain","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"add_whitelist_domain","requestBody":{"description":"Domain to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleDomainSpec"}}}}}},"/v1/policies/{id}/remove_whitelist_domain":{"post":{"tags":["Policies"],"operationId":"V1_Policies-remove_whitelist_domain","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Removes a single domain from the allowlist.","summary":"Remove allow domain","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"remove_whitelist_domain","requestBody":{"description":"Domain to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleDomainSpec"}}}}}},"/v1/policies/{id}/add_blacklist_category":{"post":{"tags":["Policies"],"operationId":"V1_Policies-add_blacklist_category","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Adds a single category to the blocklist.","summary":"Add block category","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"add_blacklist_category","requestBody":{"description":"Category to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleCategorySpec"}}}}}},"/v1/policies/{id}/remove_blacklist_category":{"post":{"tags":["Policies"],"operationId":"V1_Policies-remove_blacklist_category","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Removes a single category from the blocklist.","summary":"Remove block category","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"remove_blacklist_category","requestBody":{"description":"Category to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleCategorySpec"}}}}}},"/v1/policies/{id}/add_allowed_application":{"post":{"tags":["Policies"],"operationId":"V1_Policies-add_allowed_application","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Adds a single application to the allow list.","summary":"Add allow category","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"add_allowed_application","requestBody":{"description":"Application to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleApplicationSpec"}}}}}},"/v1/policies/{id}/remove_allowed_application":{"post":{"tags":["Policies"],"operationId":"V1_Policies-remove_allowed_application","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Removes a single application from the allow list.","summary":"Remove allow category","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"remove_allowed_application","requestBody":{"description":"Application to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleApplicationSpec"}}}}}},"/v1/policies/{id}/add_blocked_application":{"post":{"tags":["Policies"],"operationId":"V1_Policies-add_blocked_application","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Adds a single application to the block list.","summary":"Add block application","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"add_blocked_application","requestBody":{"description":"Application to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleApplicationSpec"}}}}}},"/v1/policies/{id}/remove_blocked_application":{"post":{"tags":["Policies"],"operationId":"V1_Policies-remove_blocked_application","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update policy with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicySpec"}}}}}}},"description":"Removes a single application from the block list.","summary":"Remove block application","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"remove_blocked_application","requestBody":{"description":"Application to remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateSingleApplicationSpec"}}}}}},"/v1/policies/{id}/permissive_mode":{"get":{"tags":["Policies"],"operationId":"V1_Policies-get_permissive_mode","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid parameter","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy's permissive mode value","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PolicyPermissiveModeSpec"}}}}}},"description":"Get permissive mode value.","summary":"Get permissive mode","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"get_permissive_mode"},"post":{"tags":["Policies"],"operationId":"V1_Policies-update_permissive_mode","parameters":[{"name":"id","description":"Policy ID","required":true,"in":"path","schema":{"type":"integer"}},{"name":"permissive_mode","description":"Updated permissive mode value","required":true,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid parameter","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Policy's permissive mode value","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PolicyPermissiveModeSpec"}}}}}},"description":"Update permissive mode value.","summary":"Update permissive mode","security":[{"header_authorization":[]}],"x-controller":"v1/policies","x-action":"update_permissive_mode"}},"/v1/policy_ips":{"get":{"tags":["Policy IPs"],"operationId":"V1_Policy_IPs-index","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Policy IPs basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PolicyIpSpec"}}}}}}}},"description":"Gets user associated policies IPs basic information from database.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/policy_ips","x-action":"index"}},"/v1/policy_ips/{id}":{"get":{"tags":["Policy IPs"],"operationId":"V1_Policy_IPs-show","parameters":[{"name":"id","description":"Policy IP ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Policy IP basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyIpSpec"}}}}}}},"description":"Gets basic information of the specified Policy IP.","summary":"Show IP","security":[{"header_authorization":[]}],"x-controller":"v1/policy_ips","x-action":"show"}},"/v1/psa_integrations/redirect_link":{"get":{"tags":["PSA Integrations"],"operationId":"V1_PSA_Integrations-redirect_link","parameters":[{"name":"organization_id","description":"The ID of the organization to get the redirection link for","required":false,"in":"query","schema":{"type":"integer"}},{"name":"psa_name","description":"The name of the PSA to be integrated with","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable integration request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"A redirect URL","content":{"application/json":{"schema":{"type":"string"}}}}},"description":"Creates a new PSA integration, if one does not exist and returns the redirect link.","summary":"Create link","security":[{"header_authorization":[]}],"x-controller":"v1/psa_integrations","x-action":"redirect_link"}},"/v1/scheduled_policies":{"get":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-index","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Scheduled policies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}}},"description":"Gets the list of scheduled policies associated with the current user.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"index"},"post":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create scheduled_policy with the specified data"},"201":{"description":"The created scheduled policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}},"description":"Creates a new scheduled policy.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"create","requestBody":{"description":"The scheduled policy details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}}},"/v1/scheduled_policies/all":{"get":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-all","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Scheduled policies","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}}},"description":"Gets ALL scheduled policies associated with the current user.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"all"}},"/v1/scheduled_policies/{id}":{"get":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-show","parameters":[{"name":"id","description":"ScheduledPolicy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The scheduled policy data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}},"description":"Gets the specified scheduled policy.","summary":"Show policy","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"show"},"patch":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-update","parameters":[{"name":"id","description":"ScheduledPolicy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update scheduled policy with the specified data"},"200":{"description":"Updated scheduled policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}},"description":"Updates a scheduled policy in the database with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"update","requestBody":{"description":"The scheduled policy details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledPolicy"}}}}},"delete":{"tags":["Scheduled Policies"],"operationId":"V1_Scheduled_Policies-destroy","parameters":[{"name":"id","description":"ScheduledPolicy ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Removes a scheduled policy from the database.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_policies","x-action":"destroy"}},"/v1/scheduled_report_previews/{id}":{"get":{"tags":["Scheduled Report Previews"],"operationId":"V1_Scheduled_Report_Previews-show","parameters":[{"name":"id","description":"ScheduledReportPreview ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create scheduled report with the given data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The scheduled report preview data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportPreviewSpec"}}}}}}},"description":"Gets the specified scheduled report preview.","summary":"Show preview","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_report_previews","x-action":"show"}},"/v1/scheduled_report_previews":{"post":{"tags":["Scheduled Report Previews"],"operationId":"V1_Scheduled_Report_Previews-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create scheduled report with the given data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"201":{"description":"The created scheduled report preview","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportPreviewSpec"}}}}}}},"description":"Creates a scheduled report preview, triggering the background generation.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_report_previews","x-action":"create","requestBody":{"description":"a scheduled report preview","content":{"application/json":{"schema":{"type":"object","properties":{"scheduled_report_preview":{"$ref":"#/components/schemas/ScheduledReportPreviewCreate"}}}}}}}},"/v1/scheduled_reports":{"get":{"tags":["Scheduled Reports"],"operationId":"V1_Scheduled_Reports-index","parameters":[{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Scheduled reports","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledReportSpec"}}}}}}}},"description":"Get all scheduled reports associated with current user's organizations.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_reports","x-action":"index"},"post":{"tags":["Scheduled Reports"],"operationId":"V1_Scheduled_Reports-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create scheduled report with the given data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"201":{"description":"The created scheduled report","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportSpec"}}}}}}},"description":"Creates a scheduled report.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_reports","x-action":"create","requestBody":{"description":"a scheduled report","content":{"application/json":{"schema":{"type":"object","properties":{"scheduled_report":{"$ref":"#/components/schemas/ScheduledReport"}}}}}}}},"/v1/scheduled_reports/{id}":{"get":{"tags":["Scheduled Reports"],"operationId":"V1_Scheduled_Reports-show","parameters":[{"name":"id","description":"ScheduledReport ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The scheduled report data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportSpec"}}}}}}},"description":"Gets the specified scheduled report.","summary":"Show report","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_reports","x-action":"show"},"patch":{"tags":["Scheduled Reports"],"operationId":"V1_Scheduled_Reports-update","parameters":[{"name":"id","description":"ScheduledReport ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update scheduled report with the given data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The updated scheduled report","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportSpec"}}}}}}},"description":"Updates a scheduled report.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_reports","x-action":"update","requestBody":{"description":"a scheduled report","content":{"application/json":{"schema":{"type":"object","properties":{"scheduled_report":{"$ref":"#/components/schemas/ScheduledReport"}}}}}}},"delete":{"tags":["Scheduled Reports"],"operationId":"V1_Scheduled_Reports-destroy","parameters":[{"name":"id","description":"ScheduledReport ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create scheduled report with the given data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The deleted scheduled report data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScheduledReportSpec"}}}}}}},"description":"Deletes the scheduled report.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/scheduled_reports","x-action":"destroy"}},"/v1/traffic_reports/total_requests":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequests"}}}}}}},"description":"Gets the total number of requests for sites in a period of time.","summary":"Total requests/time","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests"}},"/v1/traffic_reports/total_requests_geo":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests_geo","parameters":[{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","description":"Limit the size of the response","required":true,"in":"query","schema":{"type":"integer"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsGeo"}}}}}}},"description":"Gets the total number of requests for organizations in a period of time\nfor the heatmap on overview.","summary":"Total requests geo","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests_geo"}},"/v1/traffic_reports/total_requests_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_organizations","description":"Group report result by organization id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsOrganizations"}}}}}}},"description":"Gets the total number of requests for organizations in a period of time.","summary":"Total requests/organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests_organizations"}},"/v1/traffic_reports/total_requests_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_agents","description":"Group report result by agent id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsAgents"}}}}}}},"description":"Gets the total number of requests for roaming clients in a period of time.","summary":"Total requests clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests_agents"}},"/v1/traffic_reports/total_requests_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_users","description":"Group report result by user id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsUsers"}}}}}}},"description":"Gets the total number of requests for users in a period of time.","summary":"Total requests users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests_users"}},"/v1/traffic_reports/total_requests_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_requests_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_collections","description":"Group report result by collection id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsCollectionsResult"}}}}}}},"description":"Gets the total number of requests for collections in a period of time.","summary":"Total requests collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_requests_collections"}},"/v1/traffic_reports/total_threats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_threats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalThreats"}}}}}}},"description":"Gets the total number of threats for sites in a period of time.","summary":"Total threats/time","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_threats"}},"/v1/traffic_reports/total_threats_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_threats_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"show_individual_organizations","description":"Group report result by organization id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsOrganizations"}}}}}}},"description":"Gets the total number of threats for organizations in a period of time.","summary":"Total threats organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_threats_organizations"}},"/v1/traffic_reports/total_threats_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_threats_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"show_individual_agents","description":"Group report result by agent id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsAgents"}}}}}}},"description":"Gets the total number of threats for roaming clients in a period of time.","summary":"Total threats clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_threats_agents"}},"/v1/traffic_reports/total_threats_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_threats_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"show_individual_users","description":"Group report result by user id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsUsers"}}}}}}},"description":"Gets the total number of threats for users in a period of time.","summary":"Total threats users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_threats_users"}},"/v1/traffic_reports/total_threats_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_threats_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"show_individual_collections","description":"Group report result by collection id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsCollections"}}}}}}},"description":"Gets the total number of threats for collections in a period of time.","summary":"Total threats collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_threats_collections"}},"/v1/traffic_reports/total_categories":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_categories","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategories"}}}}}}},"description":"Gets the total number of requests by category for sites in a period of time.","summary":"Total category requests","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_categories"}},"/v1/traffic_reports/total_categories_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_categories_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_organizations","description":"Group report result by organization id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesOrganizations"}}}}}}},"description":"Gets the total number of requests by category for organizations in a period of time.","summary":"Category reqs organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_categories_organizations"}},"/v1/traffic_reports/total_categories_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_categories_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_agents","description":"Group report result by agent id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesAgents"}}}}}}},"description":"Gets the total number of requests by category for roaming clients in a period of time.","summary":"Category reqs clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_categories_agents"}},"/v1/traffic_reports/total_categories_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_categories_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_users","description":"Group report result by user id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesUsers"}}}}}}},"description":"Gets the total number of requests by category for users in a period of time.","summary":"Category reqs users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_categories_users"}},"/v1/traffic_reports/total_categories_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_categories_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_collections","description":"Group report result by collection id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesCollections"}}}}}}},"description":"Gets the total number of requests by category for collections in a period of time.","summary":"Category reqs collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_categories_collections"}},"/v1/traffic_reports/total_domains":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domains","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomains"}}}}}}},"description":"Gets the total number of requests by domain for sites in a period of time.","summary":"Total domain reqs","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domains"}},"/v1/traffic_reports/total_domains_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domains_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_organizations","description":"Group report result by organization id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsOrganizations"}}}}}}},"description":"Gets the total number of requests by domain for organizations in a period of time.","summary":"Domain reqs organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domains_organizations"}},"/v1/traffic_reports/total_domains_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domains_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_users","description":"Group report result by user id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsUsers"}}}}}}},"description":"Gets the total number of requests by domain for users in a period of time.","summary":"Domain reqs users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domains_users"}},"/v1/traffic_reports/total_domains_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domains_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_collections","description":"Group report result by collection id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsCollections"}}}}}}},"description":"Gets the total number of requests by domain for collections in a period of time.","summary":"Domain reqs collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domains_collections"}},"/v1/traffic_reports/total_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCollections"}}}}}}},"description":"Gets the total number of requests by collection for sites in a period of time.","summary":"Total collection reqs","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_collections"}},"/v1/traffic_reports/total_collections_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_collections_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_organizations","description":"Group report result by organization id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsOrganizations"}}}}}}},"description":"Gets the total number of requests by collection for organizations in a period of time.","summary":"Collection reqs orgs","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_collections_organizations"}},"/v1/traffic_reports/total_collections_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_collections_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_agents","description":"Group report result by agent id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsAgents"}}}}}}},"description":"Gets the total number of requests by collection for roaming clients in a period of time.","summary":"Collection reqs clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_collections_agents"}},"/v1/traffic_reports/total_collections_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_collections_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_users","description":"Group report result by user id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsUsers"}}}}}}},"description":"Gets the total number of requests by collection for users in a period of time.","summary":"Collection reqs users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_collections_users"}},"/v1/traffic_reports/qps":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-qps","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *1min*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 1 hour (ex.: \"Last Hour\"), bucket size is one minute\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"show_individual_networks","description":"Group report result by network id, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQps"}}}}}}},"description":"Gets the total number of queries per second in a period of time for sites.","summary":"Queries per second","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"qps"}},"/v1/traffic_reports/qps_active_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-qps_active_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQpsActiveOrganizations"}}}}}}},"description":"Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for organizations.","summary":"QPS organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"qps_active_organizations"}},"/v1/traffic_reports/qps_active_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-qps_active_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQpsActiveAgents"}}}}}}},"description":"Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for roaming clients.","summary":"QPS clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"qps_active_agents"}},"/v1/traffic_reports/qps_active_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-qps_active_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQpsActiveUsers"}}}}}}},"description":"Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for users.","summary":"QPS users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"qps_active_users"}},"/v1/traffic_reports/qps_active_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-qps_active_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQpsActiveCollections"}}}}}}},"description":"Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for collections.","summary":"QPS collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"qps_active_collections"}},"/v1/traffic_reports/top_domains":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_domains","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"fqdn","description":"search for FQDNs that contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if set to all","required":false,"in":"query","schema":{"type":"string","enum":["all","true","false"]}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopDomains"}}}}}}},"description":"Gets the top requested domains in a period of time.","summary":"Top domains","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_domains"}},"/v1/traffic_reports/top_categories":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_categories","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only categories whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if set to all","required":false,"in":"query","schema":{"type":"string","enum":["all","true","false"]}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopCategories"}}}}}}},"description":"Gets the top categories domains in a period of time.","summary":"Top categories","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_categories"}},"/v1/traffic_reports/top_application_categories":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_application_categories","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only application whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if set to all","required":false,"in":"query","schema":{"type":"string","enum":["all","true","false"]}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopCategories"}}}}}}},"description":"Gets the top application categories domains in a period of time.","summary":"Top application categories","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_application_categories"}},"/v1/traffic_reports/top_organizations":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_organizations","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only organizations whose name contains this value (and are included in the organizations_ids list)","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopOrganizations"}}}}}}},"description":"Gets the top organizations in a period of time.","summary":"Top organizations","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_organizations"}},"/v1/traffic_reports/top_networks":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_networks","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only networks whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopNetworks"}}}}}}},"description":"Gets the top networks in a period of time.","summary":"Top networks","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_networks"}},"/v1/traffic_reports/top_agents":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_agents","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only user agents whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopAgents"}}}}}}},"description":"Gets the top agents in a period of time.","summary":"Top agents","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_agents"}},"/v1/traffic_reports/top_users":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_users","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only local users whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopUsers"}}}}}}},"description":"Gets the top users in a period of time.","summary":"Top users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_users"}},"/v1/traffic_reports/top_collections":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_collections","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only local users whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopCollections"}}}}}}},"description":"Gets the top collections in a period of time.","summary":"Top collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_collections"}},"/v1/traffic_reports/query_logs":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-query_logs","parameters":[{"name":"agent_id","description":"User agent UUID","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_ids","description":"Comma separated list of User agent UUIDs","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs to include, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_id","description":"Collection ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"collection_ids","description":"Comma separated list of Collection IDs","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"exclude_category_ids","description":"Comma separated list of category IDs to exclude; drops rows matching at least one, applied independently of category_ids","required":false,"in":"query","schema":{"type":"string"}},{"name":"fqdn","description":"search for FQDNs that contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_id","description":"Network ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"policy_ids","description":"Comma separated list of policy IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"question_type","description":"Question Type of queries, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"result","description":"Type of report (all, blocked only, allowed only), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"user_id","description":"User local ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"user_ids","description":"Comma separated list of User local IDs","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsQueryLogs"}}}}}}},"description":"Gets the query raw logs in a period of time.","summary":"Query Logs","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"query_logs"}},"/v1/traffic_reports/total_organizations_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_organizations_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only applications whose display name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalOrganizationsStats"}}}}}}},"description":"Gets the total number of stats for organizations in a period of time.","summary":"Organization stats","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_organizations_stats"}},"/v1/traffic_reports/total_domain_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domain_stats","parameters":[{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"fqdn","description":"Only search for FQDNs that contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"to","description":"Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognize","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomainStats"}}}}}}},"description":"Gets the total number of stats for a domain in a period of time.","summary":"Domain stats","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domain_stats"}},"/v1/traffic_reports/total_category_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_category_stats","parameters":[{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"to","description":"Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognize","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalCategoryStats"}}}}}}},"description":"Gets the total number of stats for a category in a period of time.","summary":"Category stats","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_category_stats"}},"/v1/traffic_reports/total_organizations_requests":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_organizations_requests","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"category_ids","description":"Comma separated list of category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"fqdn","description":"search for FQDNs that contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only applications whose display name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalOrganizationsRequests"}}}}}}},"description":"Gets the total number of requests for organizations in a period of time.","summary":"Total Org Requests","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_organizations_requests"}},"/v1/traffic_reports/total_domain_requests":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_domain_requests","parameters":[{"name":"domain","description":"Only search for domains that starts with this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDomainRequests"}}}}}}},"description":"Gets the total number of requests for a domain in a period of time.","summary":"Total Domain Requests","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_domain_requests"}},"/v1/traffic_reports/top_organizations_requests":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-top_organizations_requests","parameters":[{"name":"bucket_size","description":"Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n  If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n  If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number (defaults to 1) and size (defaults to 10, maximum 100).","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTopOrganizationsRequests"}}}}}}},"description":"Gets the top organizations by number of requests.","summary":"Top Organizations Requests","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"top_organizations_requests"}},"/v1/traffic_reports/total_client_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_client_stats","parameters":[{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalClientStats"}}}}}}},"description":"Gets the organization network, users and client stats.","summary":"Total client stats","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_client_stats"}},"/v1/traffic_reports/total_deployments":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_deployments","parameters":[{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalDeployments"}}}}}}},"description":"Gets the organization deployments information.","summary":"Deployments","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_deployments"}},"/v1/traffic_reports/total_roaming_clients":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_roaming_clients","parameters":[{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_id","description":"Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalRoamingClients"}}}}}}},"description":"Gets the roaming clients information.","summary":"Roaming clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_roaming_clients"}},"/v1/traffic_reports/total_applications_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only applications whose display name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsStats"}}}}}}},"description":"Gets the statistics of number of requests by application in a period of time.","summary":"Application requests","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_stats"}},"/v1/traffic_reports/total_applications_organizations_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_organizations_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"Only organizations whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsOrganizationsStats"}}}}}}},"description":"Gets the statistics of number of requests for organizations\nby application in a period of time.","summary":"Application reqs org","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_organizations_stats"}},"/v1/traffic_reports/total_applications_networks_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_networks_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only networks whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsNetworksStats"}}}}}}},"description":"Gets the statistics of number of requests for sites by application in a period of time.","summary":"Applications reqs networks","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_networks_stats"}},"/v1/traffic_reports/total_applications_agents_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_agents_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only user agents whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsAgentsStats"}}}}}}},"description":"Gets the statistics of number of requests for roaming clients\nby application in a period of time.","summary":"Application reqs clients","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_agents_stats"}},"/v1/traffic_reports/total_applications_users_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_users_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only local users whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsUsersStats"}}}}}}},"description":"Gets the statistics of number of requests for users by\napplication in a period of time.","summary":"Application reqs users","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_users_stats"}},"/v1/traffic_reports/total_applications_collections_stats":{"get":{"tags":["Traffic Reports"],"operationId":"V1_Traffic_Reports-total_applications_collections_stats","parameters":[{"name":"agent_ids","description":"Comma separated list of user agent UUIDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_types","description":"Comma separated list of user agent types, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_category_ids","description":"Comma separated list of application category IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"application_ids","description":"Comma separated list of application IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection_ids","description":"Comma separated list of collection IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","description":"Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"mac_addresses","description":"Comma separated list of MAC addresses (without colons) or filter values, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"name","description":"Only local users whose name contains this value","required":false,"in":"query","schema":{"type":"string"}},{"name":"nat_ips","description":"Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Comma separated list of networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip","description":"Private LAN IP","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_from","description":"Private LAN IP range, lower limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"private_ip_to","description":"Private LAN IP range, upper limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"security_report","description":"Threats report true/false, *both* (threats and non-threats) if it is empty or not sent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"source","description":"Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","networks","agents","proxies"]}},{"name":"to","description":"Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400","required":false,"in":"query","schema":{"type":"string"}},{"name":"type","description":"Type of report (all, allowed, blocked), defaults to all","required":false,"in":"query","schema":{"type":"string","enum":["all","allowed","blocked"]}},{"name":"user_ids","description":"Comma separated list of local user IDs, defaults to all","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Report result","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsCollectionsStats"}}}}}}},"description":"Gets the statistics of number of requests for collections\nby application in a period of time.","summary":"Application reqs collections","security":[{"header_authorization":[]}],"x-controller":"v1/traffic_reports","x-action":"total_applications_collections_stats"}},"/v1/trials":{"post":{"tags":["Trials"],"operationId":"V1_Trials-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"The created trial","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TrialSpec"}}}}}}},"description":"Create trial.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/trials","x-action":"create","requestBody":{"description":"The organization_id and sku","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialCreate"}}}}}},"/v1/user_agent_bulk_deletes":{"post":{"tags":["User Agent Bulk Deletes"],"operationId":"V1_User_Agent_Bulk_Deletes-create","parameters":[{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"]}},{"name":"agent_version","description":"Filter user agents by agent version.","required":false,"in":"query","schema":{"type":"string"}},{"name":"block_page_id","description":"Filter user agents by block page ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Organization IDs","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"policy_id","description":"Filter user agents by policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"policy_schedule","description":"Filter user agents by policy/schedule name","required":false,"in":"query","schema":{"type":"string"}},{"name":"queue_uninstall","description":"either soft delete or uninstall based on this value","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"release_channels","description":"Filter user agents by release channel. Valid values: stable, beta, preview","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"}}}},{"name":"scheduled_policy_id","description":"Filter user agents by scheduled_policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent bulk delete","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentBulkDelete"}}}}}}},"description":"Create a user agent bulk delete.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_deletes","x-action":"create","requestBody":{"description":"User agent bulk delete information, ids overrides filters, exclude_ids removes agents from filtered set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentBulkDeleteCreate"}}}}}},"/v1/user_agent_bulk_deletes/{id}":{"get":{"tags":["User Agent Bulk Deletes"],"operationId":"V1_User_Agent_Bulk_Deletes-show","parameters":[{"name":"id","description":"Id of user agent bulk delete","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent bulk delete","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentBulkDelete"}}}}}}},"description":"Gets a user agent bulk delete by id.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_deletes","x-action":"show"}},"/v1/user_agent_bulk_deletes/counts":{"get":{"tags":["User Agent Bulk Deletes"],"operationId":"V1_User_Agent_Bulk_Deletes-counts","parameters":[{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"]}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent counts information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentBulkDeleteCounts"}}}}},"description":"Gets a user agent bulk delete counts by id.","summary":"Counts","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_deletes","x-action":"counts"}},"/v1/user_agent_bulk_updates":{"post":{"tags":["User Agent Bulk Updates"],"operationId":"V1_User_Agent_Bulk_Updates-create","parameters":[{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"]}},{"name":"agent_version","description":"Filter user agents by agent version.","required":false,"in":"query","schema":{"type":"string"}},{"name":"block_page_id","description":"Filter user agents by block page ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"organization_ids","description":"Organization IDs","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"policy_id","description":"Filter user agents by policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"policy_schedule","description":"Filter user agents by policy/schedule name","required":false,"in":"query","schema":{"type":"string"}},{"name":"release_channels","description":"Filter user agents by release channel. Valid values: stable, beta, preview","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"}}}},{"name":"scheduled_policy_id","description":"Filter user agents by scheduled_policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent bulk update","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentBulkUpdate"}}}}}}},"description":"Create a user agent bulk update.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_updates","x-action":"create","requestBody":{"description":"User agent bulk update information, ids overrides filters, exclude_ids removes agents from filtered set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentBulkUpdateCreate"}}}}}},"/v1/user_agent_bulk_updates/{id}":{"get":{"tags":["User Agent Bulk Updates"],"operationId":"V1_User_Agent_Bulk_Updates-show","parameters":[{"name":"id","description":"Id of user agent bulk update","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent bulk update","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentBulkUpdate"}}}}}}},"description":"Gets a user agent bulk update by id.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_updates","x-action":"show"}},"/v1/user_agent_bulk_updates/has_mixed":{"post":{"tags":["User Agent Bulk Updates"],"operationId":"V1_User_Agent_Bulk_Updates-has_mixed","parameters":[{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"]}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Selected user agents mixed attributes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentBulkUpdateHasMixed"}}}}}}},"description":"Gets the value of whether each of the attributes of the elected user agents are mixed.","summary":"Check agent values","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_updates","x-action":"has_mixed","requestBody":{"description":"The user agent bulk selected ids","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentBulkUpdateHasMixedRequest"}}}}}},"/v1/user_agent_bulk_updates/counts":{"get":{"tags":["User Agent Bulk Updates"],"operationId":"V1_User_Agent_Bulk_Updates-counts","parameters":[{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"]}},{"name":"block_page_id","description":"Filter user agents by block page ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"policy_id","description":"Filter user agents by policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"release_channels","description":"Filter user agents by release channel. Valid values: stable, beta, preview","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"}}}},{"name":"scheduled_policy_id","description":"Filter user agents by scheduled_policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent counts information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentBulkDeleteCounts"}}}}},"description":"Gets a user agent bulk delete counts by id.","summary":"Counts","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_bulk_updates","x-action":"counts"}},"/v1/user_agent_cleanups":{"post":{"tags":["User Agent Cleanups"],"operationId":"V1_User_Agent_Cleanups-create","parameters":[],"responses":{"200":{"description":"User agent cleanup","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentCleanup"}}}}}}},"description":"Creates a user agent cleanup to track bulk deletion of user agents.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_cleanups","x-action":"create","requestBody":{"description":"User agent cleanup information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentCleanupCreate"}}}}}},"/v1/user_agent_cleanups/{id}":{"get":{"tags":["User Agent Cleanups"],"operationId":"V1_User_Agent_Cleanups-show","parameters":[{"name":"id","description":"Id of user agent cleanup","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"200":{"description":"User agent cleanup","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentCleanup"}}}}}}},"description":"Gets the specific user agent cleanup.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_cleanups","x-action":"show"},"put":{"tags":["User Agent Cleanups"],"operationId":"V1_User_Agent_Cleanups-update","parameters":[{"name":"id","description":"Id of user agent cleanup","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"200":{"description":"User agent cleanup","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentCleanup"}}}}}}},"description":"Updates a user agent cleanup.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_cleanups","x-action":"update","requestBody":{"description":"start property will start the cleanup and will do nothing if inactive_for is included. inactive_for is the number of inactive days, updating restarts job to find RCs to delete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentCleanupUpdate"}}}}}},"/v1/user_agent_csv_exports":{"post":{"tags":["User Agent CSV Exports"],"operationId":"V1_User_Agent_CSV_Exports-create","parameters":[],"responses":{"200":{"description":"User agent csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentCsvExport"}}}}}}},"description":"Creates a user agent csv export record to track export of user agents.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_csv_exports","x-action":"create","requestBody":{"description":"User agent csv export information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentCsvExportCreate"}}}}}},"/v1/user_agent_csv_exports/{id}":{"get":{"tags":["User Agent CSV Exports"],"operationId":"V1_User_Agent_CSV_Exports-show","parameters":[{"name":"id","description":"Id of user agent csv export","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"200":{"description":"User agent csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentCsvExport"}}}}}}},"description":"Gets the specific user agent csv export.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_csv_exports","x-action":"show"}},"/v1/user_agent_releases":{"get":{"tags":["User Agent Releases"],"operationId":"V1_User_Agent_Releases-index","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"A list of user agent releases","content":{"application/json":{"schema":{"type":"object","properties":{"user_agent_releases":{"type":"array","items":{"$ref":"#/components/schemas/UserAgentRelease"}}}}}}}},"description":"Gets a list of latest user agent releases for each unique combination of\nagent_type, architecture, release_channels, and white label.","summary":"Get","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_releases","x-action":"index"}},"/v1/user_agent_releases/relay":{"get":{"tags":["User Agent Releases"],"operationId":"V1_User_Agent_Releases-relay","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"A list of user agent releases","content":{"application/json":{"schema":{"type":"object","properties":{"user_agent_releases":{"type":"array","items":{"$ref":"#/components/schemas/UserAgentRelease"}}}}}}}},"description":"Gets a list of latest relay releases for each unique combination of\narchitecture, release_channels, and white label.","summary":"Get relay","security":[{"header_authorization":[]}],"x-controller":"v1/user_agent_releases","x-action":"relay"}},"/v1/user_agents":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-index","parameters":[{"name":"agent_local_user_uuids","description":"Filter to roaming clients associated with these users. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG).","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"agent_state","description":"filter by agent state","required":false,"in":"query","schema":{"type":"string","enum":["protected","unprotected","bypassed","pending_uninstall","uninstalled","offline"]}},{"name":"agent_type","description":"Filter user agents by agent type. Valid values: windows, macos, ios, android, chrome. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"agent_version","description":"Filter user agents by agent version. Valid operators: startswith, equals, doesnotequal, contains, doesnotcontain, endswith","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"auto_update","description":"Filter user agents by their organization's auto update value","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"block_page_id","description":"Filter user agents by block page ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"browser_extension_status","description":"Filter by browser extension status (chrome or edge). Valid values: installed, not_responding, not_installed. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"cybersight_enabled","description":"When true, use OpenSearch for Cybersight activity in the time window: with agent_local_user_uuids, filter to roaming clients linked to those users; without, filter to roaming clients with activity on Cybersight-eligible agents in scope. When false, use Postgres only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"cybersight_status","description":"Filter by CyberSight service status. Valid values: active, inactive, disabled, not_available. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"end_at","description":"ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true.","required":false,"in":"query","schema":{"type":"string"}},{"name":"msp_id","description":"MSP ID, set scope to all sub-orgs","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name_search","description":"Filter user agent by client name fields (i.e. hostname and friendly_name). Valid operators: contains, doesnotcontain","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"new_agent_states","description":"assign user agents new agent states: Protected, Unprotected, Offline","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"policy_id","description":"Filter user agents by policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"policy_schedule","description":"Filter user agents by policy/schedule name","required":false,"in":"query","schema":{"type":"string"}},{"name":"release_channels","description":"Filter user agents by release channel. Valid values: stable, beta, preview. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"scheduled_policy_id","description":"Filter user agents by scheduled_policy ID","required":false,"in":"query","schema":{"type":"integer"}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: status, hostname, friendly name, current logged in user","required":false,"in":"query","schema":{"type":"string"}},{"name":"sort","description":"Sort options, valid attributes: hostname, friendly_name, agent_version, last_sync, agent_state, vpn_status, private_network (connected, not_connected, disabled)","required":false,"in":"query","schema":{"type":"string"}},{"name":"start_at","description":"ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted =\u003e last 91 days unless paired with end_at.","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled, uninstall_queued, uninstalling","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"traffic_received_last_15_mins","description":"filter by agents that have received traffic in last 15 minutes","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}},{"name":"vpn_mode","description":"Filter by VPN mode (agent-level overrides org-level). Valid values: manual, always_on. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"vpn_status","description":"Filter by VPN connectivity status. Valid values: connected, not_connected, disabled. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agents basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserAgentSpec"}},"links":{"$ref":"#/components/schemas/Links"},"meta":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UserAgentCount"}}}}}}}},"description":"Gets a list of user agents with basic information.","summary":"Get extant agents","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"index"}},"/v1/user_agents/all":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-all","parameters":[{"name":"agent_local_user_uuids","description":"Filter to roaming clients associated with these users. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG).","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"cybersight_enabled","description":"When true, use OpenSearch for Cybersight activity in the time window: with agent_local_user_uuids, filter to roaming clients linked to those users; without, filter to roaming clients with activity on Cybersight-eligible agents in scope. When false, use Postgres only (default: false)","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"end_at","description":"ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true.","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_id","description":"Organization ID to scope agents","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: status, hostname, friendly name, current logged in user","required":false,"in":"query","schema":{"type":"string"}},{"name":"sort","description":"Sort options, valid attributes: hostname, friendly_name, agent_version, last_sync","required":false,"in":"query","schema":{"type":"string"}},{"name":"start_at","description":"ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted =\u003e last 91 days unless paired with end_at.","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled, uninstall_queued, uninstalling","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agents basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserAgentSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets a list of ALL user agents with basic information.","summary":"Get all agents","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"all"}},"/v1/user_agents/counts":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-counts","parameters":[{"name":"msp_id","description":"MSP ID, set scope to all sub-orgs","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name_search","description":"A search term to search client name fields (i.e. hostname and friendly_name)","required":false,"in":"query","schema":{"type":"string"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"new_agent_states","description":"Get counts for new agent states: Protected, Unprotected, Offline","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"release_channels","description":"Filter user agents by release channel. Valid values: stable, beta, preview. Valid operators: is, isnot","required":false,"in":"query","schema":{"type":"object","properties":{"value":{"type":"string"},"operator":{"type":"string"}}}},{"name":"search","description":"User agent list by keyword(s) (space delimited), this could be: tags, status, hostname, friendly name, current logged in user","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"filter by user agent online/offline state","required":false,"in":"query","schema":{"type":"string","enum":["online","offline"]}},{"name":"status","description":"filter by user agent status, valid attributes: active, disabled, uninstalled","required":false,"in":"query","schema":{"type":"string"}},{"name":"tags","description":"User agent list by tags","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"type","description":"User agent type, defaults to non-proxy/no-relays user agents","required":false,"in":"query","schema":{"type":"string","enum":["proxy","agents"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent counts information (legacy agent states)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyUserAgentCounts"}}}}},"description":"Gets counts of user agents for each status.","summary":"Counts","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"counts"}},"/v1/user_agents/{id}":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-show","parameters":[{"name":"id","description":"User agent UUID","required":true,"in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User agent basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentSpec"}}}}}}},"description":"Gets the specified user agent with basic information.","summary":"Show agent","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"show"},"patch":{"tags":["User Agents"],"operationId":"V1_User_Agents-update","parameters":[{"name":"id","description":"User agent UUID","required":true,"in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update user agent with the specified data","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"200":{"description":"Updated user agent basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserAgentSpec"}}}}}}},"description":"Updates an user agent with the specified data.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"update","requestBody":{"description":"User agent information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentPatchSpec"}}}}},"delete":{"tags":["User Agents"],"operationId":"V1_User_Agents-destroy","parameters":[{"name":"clear_registry","description":"Clear registry when uninstalling user agent","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"id","description":"User agent UUID","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"name":"queue_uninstall","description":"Uninstall user agent","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not delete user agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"No Content"}},"description":"Soft deletes an user agent.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"destroy"}},"/v1/user_agents/tags":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-tags","parameters":[{"name":"include_used_only","description":"Filters out tags that aren't current used on any user agents","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"msp_id","description":"MSP ID, set scope to all sub-orgs","required":false,"in":"query","schema":{"type":"integer"}},{"name":"network_ids","description":"Networks IDs, defaults to all","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Tags array","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"Gets ALL tags used by user agents on a network or organization.","summary":"Get tags","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"tags"}},"/v1/user_agents/dequeue_uninstall":{"post":{"tags":["User Agents"],"operationId":"V1_User_Agents-dequeue_uninstall","parameters":[{"name":"id","description":"User agent ID","required":true,"in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not remove user agent from queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"A +success+ flag indicating if the agent was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"description":"Removes user agent from uninstall queue.","summary":"Remove queue","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"dequeue_uninstall"}},"/v1/user_agents/csv":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-csv","parameters":[{"name":"include_suborgs","description":"Include suborgs when organization_id is msp owner org, defaults to false","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}},{"name":"timezone","description":"The timezone string (e.g. America/New_York) for localizing the filename, defaults to \"UTC\"","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"A csv document","content":{"application/json":{"schema":{"type":"string"}}}}},"description":"Gets CSV of organization's user agents.","summary":"CSV Export","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"csv"}},"/v1/user_agents/uninstall_pin":{"get":{"tags":["User Agents"],"operationId":"V1_User_Agents-uninstall_pin","parameters":[{"name":"organization_id","description":"Organization ID","required":true,"in":"query","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Organization's user agent uninstall pin","content":{"application/json":{"schema":{"type":"string"}}}}},"description":"Gets Uninstall pin for organization's user agents.","summary":"PIN","security":[{"header_authorization":[]}],"x-controller":"v1/user_agents","x-action":"uninstall_pin"}},"/v1/users":{"get":{"tags":["Users"],"operationId":"V1_Users-index","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Users basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets users basic information.","summary":"Get extant","security":[{"header_authorization":[]}],"x-controller":"v1/users","x-action":"index"}},"/v1/users/all":{"get":{"tags":["Users"],"operationId":"V1_Users-all","parameters":[{"name":"page","description":"Page number and size","required":false,"in":"query","schema":{"type":"object","properties":{"number":{"type":"integer"},"size":{"type":"integer"}}}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Users basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSpec"}},"links":{"$ref":"#/components/schemas/Links"}}}}}}},"description":"Gets ALL users basic information.","summary":"Get all","security":[{"header_authorization":[]}],"x-controller":"v1/users","x-action":"all"}},"/v1/users/{id}":{"get":{"tags":["Users"],"operationId":"V1_Users-show","parameters":[{"name":"id","description":"User ID","required":true,"in":"path","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["self"]}]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"User basic information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserSpec"}}}}}}},"description":"Gets basic information of the specified user.","summary":"Show user","security":[{"header_authorization":[]}],"x-controller":"v1/users","x-action":"show"}},"/v1/users/change_password":{"patch":{"tags":["Users"],"operationId":"V1_Users-change_password","parameters":[],"responses":{"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Password changed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"description":"Changes the password for the currently authenticated user.","summary":"Change password","security":[{"header_authorization":[]}],"x-controller":"v1/users","x-action":"change_password","requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"new_password":{"type":"string"}}}}}}}},"/v2/agent_local_users/counts":{"get":{"tags":["Agent Local Users"],"operationId":"V2_Agent_Local_Users-counts","parameters":[{"name":"msp_id","description":"MSP ID. When provided, returns counts across all organizations belonging to this MSP.","required":false,"in":"query","schema":{"type":"integer"}},{"name":"name","description":"filter by name. If friendly_name not found, will search by user_name","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization_ids","description":"Organization IDs, defaults to user organization ID","required":false,"in":"query","schema":{"type":"array","items":{"type":"integer"}},"explode":true},{"name":"search","description":"Filter by name or user_login","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local user counts","content":{"application/json":{"schema":{"type":"object","properties":{"all":{"type":"integer"},"user_policy_override":{"type":"integer"},"inherited_policy":{"type":"integer"}}}}}}},"description":"Gets counts of agent local users by policy assignment status.","summary":"Count users","security":[{"header_authorization":[]}],"x-controller":"v2/agent_local_users","x-action":"counts"}},"/v2/agent_local_users_csv_export":{"post":{"tags":["Agent Local Users CSV Export"],"operationId":"V2_Agent_Local_Users_CSV_Export-create","parameters":[],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local users CSV export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUsersCsvExport"}}}}}}},"description":"Creates an agent local users CSV export record to track export of agent local users.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v2/agent_local_users_csv_export","x-action":"create","requestBody":{"description":"Agent local users CSV export information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentLocalUsersCsvExportCreate"}}}}}},"/v2/agent_local_users_csv_export/{id}":{"get":{"tags":["Agent Local Users CSV Export"],"operationId":"V2_Agent_Local_Users_CSV_Export-show","parameters":[{"name":"id","description":"UUID of agent local users CSV export","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Agent local users CSV export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgentLocalUsersCsvExport"}}}}}}},"description":"Shows an agent local users CSV export.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v2/agent_local_users_csv_export","x-action":"show"}},"/v2/current_user/suppress_license_warning":{"post":{"tags":["User Organization UI Settings"],"operationId":"V2_User_Organization_UI_Settings-suppress_license_warning","parameters":[{"name":"body","description":"body","required":true,"in":"query","schema":{"type":"object","properties":{"organization_uuid":{"type":"string"}}}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Suppression date information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseWarningSuppressionData"}}}}},"description":"Returns the suppression date and relevant information.","summary":"Suppresses license warning","security":[{"header_authorization":[]}],"x-controller":"v2/current_user/organization_ui_settings","x-action":"suppress_license_warning"}},"/v2/current_user/ui_settings":{"get":{"tags":["User UI Settings"],"operationId":"V2_User_UI_Settings-show","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Current User's UI settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUiSetting"}}}}},"description":"Returns the current user's UI settings.","summary":"Get UI Settings","security":[{"header_authorization":[]}],"x-controller":"v2/current_user/ui_settings","x-action":"show"},"patch":{"tags":["User UI Settings"],"operationId":"V2_User_UI_Settings-update","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Current User's UI settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUiSetting"}}}}},"description":"Updates current user's UI settings.","summary":"Update UI Settings","security":[{"header_authorization":[]}],"x-controller":"v2/current_user/ui_settings","x-action":"update","requestBody":{"description":"User UI settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUiSetting"}}}}}},"/v2/cyber_sight/csv_exports/create":{"post":{"tags":["Cybersight CSV Exports"],"operationId":"V2_Cybersight_CSV_Exports-create","parameters":[{"name":"ai_tool","description":"Required when report_type is top_ai_usage. Determines which AI activity view to export: \"web\" for AI websites, \"app\" for AI applications, \"all\" for a combined web+app row list, \"client\" for AI usage per roaming client.","required":false,"in":"query","schema":{"type":"string","enum":["all","web","app","client"]}},{"name":"end_at","description":"format:iso8601 End date/time for the report query, required","required":false,"in":"query","schema":{"type":"string"}},{"name":"included_columns","description":"Column keys to include; must be nested under cyber_sight_csv_export in the request body (e.g. cyber_sight_csv_export: { included_columns: [...] }). Invalid keys are ignored; order is preserved where applicable.\nFor activity_logs: see activity_logs filter list (e.g. organization_name, activity_type, web_host, app_name, etc).\nFor top_websites: organization_name, web_host, categories, unique user counts,\nactivity_count, focus times \u0026 percentages.\nFor top_applications: organization_name, application, user_agent_count_unique,\nagent_local_user_count_unique, activity_count, application_focus_in_seconds, percent_time.\nFor top_categories: organization_name, category, user_agent_count_unique, agent_local_user_count_unique,\nactivity_count, category_focus_in_seconds, percent_time.\nFor top_streaming: organization_name, streaming_app_name, user_agent_count_unique,\nagent_local_user_count_unique, activity_count, streaming_app_focus_in_seconds, percent_time.\nFor top_risky_users: organization_name, user_name, event_count, time_in_seconds,\npercent_company_time, percent_of_events.\nFor top_active_clients: organization_name, roaming_client, user_count,\ntime_in_seconds, percent_time.\nFor top_ai_usage (ai_tool=web): organization_name, web_host, user_agent_count_unique,\nagent_local_user_count_unique, activity_count, time_in_seconds, percent_time, categories.\nFor top_ai_usage (ai_tool=all): organization_name, ai_tool, user_agent_count_unique,\nagent_local_user_count_unique, activity_count, time_in_seconds, percent_time, categories\n(\"-\" for application rows; comma-joined web category names for website rows).\nFor top_ai_usage (ai_tool=app): organization_name, application, user_agent_count_unique,\nagent_local_user_count_unique, activity_count, time_in_seconds, percent_time.\nFor top_ai_usage (ai_tool=client): organization_name, roaming_client, user_count,\ntime_in_seconds, percent_time.","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"explode":true},{"name":"report_type","description":"Type of CyberSight Report csv export, required.","required":false,"in":"query","schema":{"type":"string","enum":["activity_logs","top_websites","top_applications","top_categories","top_streaming","top_risky_users","top_active_clients","top_ai_usage"]}},{"name":"start_at","description":"format:iso8601 Start date/time for the report query, required","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable entity (e.g. unknown report_type)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"CyberSight csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CyberSightCsvExport"}}}}}}},"description":"Creates a cybersight csv export record to track export of cybersight report info.\nInvalid report filters and invalid included_columns are ignored; the CSV is generated\nusing any valid filters and columns that remain.\n\nFilters (query/body) by report type:\n  activity_logs: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids, user_agent_uuids,\n    agent_local_user_uuids, weekdays_only, search_id, size, sort_direction, activity_type_ids,\n    app_executable_path, app_name, app_window_title, web_full_url, web_host.\n  top_websites: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids, user_agent_uuids,\n    agent_local_user_uuids, weekdays_only, search_id, size, sort_direction, web_full_url, web_host.\n  top_applications: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction, app_name,\n    app_executable_path, app_window_title.\n  top_categories: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction, threats_only, web_categories.\n  top_streaming: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction, app_name.\n  top_risky_users: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction.\n  top_active_clients: start_at, end_at, org_uuids, msp_uuid, excluded_org_uuids, category_ids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction.\n  top_ai_usage: start_at, end_at, ai_tool (required), org_uuids, msp_uuid, excluded_org_uuids,\n    user_agent_uuids, agent_local_user_uuids, weekdays_only, search_id, size, sort_direction.\n    When ai_tool=web: web_full_url, web_host.\n    When ai_tool=app: app_name, app_executable_path, app_window_title.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v2/cyber_sight_csv_exports","x-action":"create","requestBody":{"description":"CyberSight csv export information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CyberSightCsvExportCreate"}}}}}},"/v2/cyber_sight/csv_exports/{id}":{"get":{"tags":["Cybersight CSV Exports"],"operationId":"V2_Cybersight_CSV_Exports-show","parameters":[{"name":"id","description":"uuid of CyberSight csv export","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"CyberSight csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CyberSightCsvExport"}}}}}},"202":{"description":"Export is still processing","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CyberSightCsvExportPending"}}}}}}},"description":"Shows a CyberSight csv export.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v2/cyber_sight_csv_exports","x-action":"show"}},"/v2/dashboards":{"get":{"tags":["Dashboards"],"operationId":"V2_Dashboards-index","parameters":[],"responses":{"200":{"description":"Dashboards","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}}},"description":"Dasbboards for use by the current user. The user's default dashboard will\nbe returned first, the rest alphabetically by name.","summary":"User's Dashboards","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"index"},"post":{"tags":["Dashboards"],"operationId":"V2_Dashboards-create","parameters":[],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not create the dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"201":{"description":"Created dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}}},"description":"Create a dashboard.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"create","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreateSpec"}}}}}},"/v2/dashboards/available":{"get":{"tags":["Dashboards"],"operationId":"V2_Dashboards-available","parameters":[],"responses":{"200":{"description":"Dashboards","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}}},"description":"Dashboards available to the current user.","summary":"Available Dashboards","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"available"}},"/v2/dashboards/owned":{"get":{"tags":["Dashboards"],"operationId":"V2_Dashboards-owned","parameters":[],"responses":{"200":{"description":"Dashboards","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}}}}}},"description":"Dashboards owned by the current user.","summary":"Owned Dashboards","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"owned"}},"/v2/dashboards/{id}":{"patch":{"tags":["Dashboards"],"operationId":"V2_Dashboards-update","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update the dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Updated dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}}},"description":"Update a dashboard.","summary":"Update","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"update","requestBody":{"description":"body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardUpdateSpec"}}}}},"delete":{"tags":["Dashboards"],"operationId":"V2_Dashboards-destroy","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not destroy the dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"Dashboard successfully deleted."}},"description":"Delete a dashboard.","summary":"Delete","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"destroy"}},"/v2/dashboards/{id}/make_public":{"post":{"tags":["Dashboards"],"operationId":"V2_Dashboards-make_public","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Dashboard successfully made public."}},"description":"This will make it available to other users who are members in an\norganization the owning user is a member of.","summary":"Make Public","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"make_public"}},"/v2/dashboards/{id}/make_private":{"post":{"tags":["Dashboards"],"operationId":"V2_Dashboards-make_private","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Dashboard successfully made private."}},"description":"This will remove access to the dashboard for other users.","summary":"Make Private","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"make_private"}},"/v2/dashboards/{id}/link":{"post":{"tags":["Dashboards"],"operationId":"V2_Dashboards-link","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not link the dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"Dashboard successfully linked."}},"description":"Linking a dashboard will add it to the list for the current user.","summary":"Link","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"link"}},"/v2/dashboards/{id}/unlink":{"post":{"tags":["Dashboards"],"operationId":"V2_Dashboards-unlink","parameters":[{"name":"id","description":"Dashboard ID","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not unlink the dashboard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"204":{"description":"Dashboard successfully unlinked."}},"description":"Unlinking a dashboard will remove it from the list of dashboards for the\ncurrent user.","summary":"Unlink","security":[{"header_authorization":[]}],"x-controller":"v2/dashboards","x-action":"unlink"}},"/v2/dictionary/ai_applications":{"get":{"tags":["Dictionary Lookups"],"operationId":"V2_Dictionary_Lookups-ai_applications","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"description":"Return a list of AI Applications and websites.","summary":"AI Applications","x-controller":"v2/dictionary","x-action":"ai_applications"}},"/v2/dictionary/cyber_sight_activity_types":{"get":{"tags":["Dictionary Lookups"],"operationId":"V2_Dictionary_Lookups-cyber_sight_activity_types","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightActivityType"}}}}}},"description":"Returns all available CyberSightReports activity types.","summary":"CyberSight Activity Types","x-controller":"v2/dictionary","x-action":"cyber_sight_activity_types"}},"/v2/dictionary/vpn_settings_state_types":{"get":{"tags":["Dictionary Lookups"],"operationId":"V2_Dictionary_Lookups-vpn_settings_state_types","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VpnSettingsStateType"}}}}}},"description":"Returns all available VPN Settings State types.","summary":"VPN Settings State Types","x-controller":"v2/dictionary","x-action":"vpn_settings_state_types"}},"/v2/networks_csv_export":{"post":{"tags":["Networks CSV Exports"],"operationId":"V2_Networks_CSV_Exports-create","parameters":[{"name":"ip_search","description":"Network ip/hostname search","required":false,"in":"query","schema":{"type":"string"}},{"name":"protected","description":"Network status of protected","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"search","description":"Network name search","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","description":"Network status search (online/offline)","required":false,"in":"query","schema":{"type":"string"}},{"name":"unprotected","description":"Network status of protected","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Network csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworksCsvExport"}}}}}}},"description":"Creates a networks csv export record to track export of networks.","summary":"Create","security":[{"header_authorization":[]}],"x-controller":"v2/networks_csv_export","x-action":"create","requestBody":{"description":"Network csv export information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworksCsvExportCreate"}}}}}},"/v2/networks_csv_export/{id}":{"get":{"tags":["Networks CSV Exports"],"operationId":"V2_Networks_CSV_Exports-show","parameters":[{"name":"id","description":"Id of Network csv export","required":true,"in":"path","schema":{"type":"integer"}}],"responses":{"200":{"description":"Network csv export","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworksCsvExport"}}}}}}},"description":"Shows a networks csv export.","summary":"Show","security":[{"header_authorization":[]}],"x-controller":"v2/networks_csv_export","x-action":"show"}},"/v2/user_agents/{id}/update_settings":{"patch":{"tags":["User Agents"],"operationId":"V2_User_Agents-update_settings","parameters":[{"name":"id","description":"User agent UUID","required":true,"in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Can not update user agent with the specified data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"200":{"description":"Updated user agent","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}},"description":"Updates both device settings and filtering client settings for a user agent.","summary":"Update settings","security":[{"header_authorization":[]}],"x-controller":"v2/user_agents","x-action":"update_settings","requestBody":{"description":"User agent information","content":{"application/json":{"schema":{"type":"object","properties":{"user_agent":{"$ref":"#/components/schemas/UserAgentSettingsBody"}}}}}}}}},"tags":[{"name":"Agent Local User Bulk Deletes","description":""},{"name":"Agent Local Users","description":""},{"name":"Agent Local Users CSV Export","description":""},{"name":"Api Keys","description":""},{"name":"Application Categories","description":""},{"name":"Applications","description":"Get information about available applications for the allow and block lists."},{"name":"Auth0","description":""},{"name":"Billings","description":""},{"name":"Block Pages","description":""},{"name":"Categories","description":""},{"name":"Collection Users","description":""},{"name":"Cybersight CSV Exports","description":""},{"name":"Dashboards","description":""},{"name":"Dictionary Lookups","description":""},{"name":"Distributors","description":""},{"name":"Domain Notes","description":""},{"name":"Domains","description":""},{"name":"Enterprise Connections","description":""},{"name":"Invoices","description":""},{"name":"IP Addresses","description":""},{"name":"MAC Addresses","description":""},{"name":"Metrics","description":""},{"name":"Network LAN IPs","description":""},{"name":"Network Subnets","description":""},{"name":"Networks","description":""},{"name":"Networks CSV Exports","description":""},{"name":"Organization Users","description":""},{"name":"Organizations","description":""},{"name":"Policies","description":""},{"name":"Policies Bulk Actions","description":""},{"name":"Policy IPs","description":""},{"name":"PSA Integrations","description":""},{"name":"Scheduled Policies","description":""},{"name":"Scheduled Report Previews","description":""},{"name":"Scheduled Reports","description":""},{"name":"Traffic Reports","description":""},{"name":"Trials","description":""},{"name":"User (Current)","description":""},{"name":"User Agent Bulk Deletes","description":""},{"name":"User Agent Bulk Updates","description":""},{"name":"User Agent Cleanups","description":""},{"name":"User Agent CSV Exports","description":""},{"name":"User Agent Releases","description":""},{"name":"User Agents","description":""},{"name":"User Organization UI Settings","description":"Manage UI settings for the current user related to Organizations"},{"name":"User UI Settings","description":"Manage UI settings for the current user."},{"name":"Users","description":""}],"components":{"schemas":{"AgentLocalUser":{"type":"object","properties":{"friendly_name":{"type":"string","description":"User friendly name (may be null)"},"user_login":{"type":"string","description":"User remote login"},"user_name":{"type":"string","description":"User remote name (may be null)"},"user_remote_id":{"type":"string","description":"User remote ID (may be null)"},"first_seen":{"type":"string","format":"date","description":"First time the user was seen"},"last_seen":{"type":"string","format":"date","description":"Last time the user was seen"}},"description":"Agent local user resource"},"AgentLocalUserSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/AgentLocalUser"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"Agent local user associated objects"}}}],"description":"Agent local user specification"},"AgentLocalUserUpdate":{"type":"object","properties":{"friendly_name":{"type":"string","description":"Agent local user friendly name"},"policy_id":{"type":"integer","description":"Agent local user custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set"},"scheduled_policy_id":{"type":"integer","description":"Agent local user custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"Agent local user custom block page ID"}},"description":"Agent local user update request parameters"},"AgentLocalUserBulkUpdate":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"IDs of agent local users to update. Overrides any filter params. Omit or pass [] to use filter mode."},"exclude_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of agent local users to exclude when using filter mode"},"policy_id":{"type":"integer","description":"Policy ID to assign. Explicitly null clears the override; omitting the field leaves the existing value unchanged."},"block_page_id":{"type":"integer","description":"Block page ID to assign. Explicitly null clears the override; omitting the field leaves the existing value unchanged."}},"description":"Agent local user bulk update request parameters"},"AgentLocalUserUpdateSpec":{"type":"object","properties":{"agent_local_user":{"$ref":"#/components/schemas/AgentLocalUserUpdate"}},"required":["agent_local_user"],"description":"Agent local user update request parameters"},"AgentLocalUserBulkDeletes":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"Ids of agent local users to delete. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"integer"},"description":"Ids of agent local users to remove from delete when using filters"}},"description":"Agent local user bulk delete request parameters"},"AgentLocalUserBulkDeletesCounts":{"type":"object","properties":{"count":{"type":"integer"}},"description":"Agent local user bulk delete counts"},"AgentLocalUsersCsvExport":{"type":"object","properties":{"uuid":{"type":"string","description":"Agent local users csv export UUID"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs"},"url":{"type":"string","description":"URL to download the CSV (null until job completes)"},"error":{"type":"string","description":"Error message if export failed"}},"description":"Agent local users csv export"},"AgentLocalUsersCsvExportCreate":{"type":"object","properties":{"agent_local_users_csv_export":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"search":{"type":"string"},"user_policy_override":{"type":"boolean"}},"description":"CSV export attributes"}},"description":"Agent local users csv export"},"Agreement":{"type":"object","properties":{"current_version_id":{"type":"integer","description":"ID of current agreement version"},"title":{"type":"string","description":"Title"},"priority":{"type":"integer","description":"The relative priority of this agreement (ascending)"},"body":{"type":"string","description":"The body of the current version of the agreement"},"updated_at":{"type":"string","format":"date","description":"The time the current version was last updated"}},"description":"Agreement resource"},"AgreementAcceptance":{"type":"object","properties":{"metadata":{"type":"object","description":"Optional attributes stored with the acceptance"},"accepted_at":{"type":"string","format":"date","description":"The time the user accepted the agreement"},"version_id":{"type":"string","description":"The version of agreement signed"}},"description":"AgreementAcceptance resource"},"AgreementAcceptanceSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/AgreementAcceptance"},"relationships":{"type":"object","properties":{"user":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"AgreementAcceptance hierarchy"}}}],"description":"AgreementAcceptance specification"},"AgreementSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Agreement"}}}],"description":"Agreement specification"},"ApiKey":{"type":"object","properties":{"name":{"type":"string","description":"name"},"expiry":{"type":"string","description":"2024-12-22T17:24:32.162-05:00 intended expiry"},"last_four":{"type":"string","description":"last four digits of the token"},"token":{"type":"string","description":"full token on initial create or a redacted token with last four. i.e: ***************Lhz4"},"status":{"type":"string","description":"token status (active, revoked)"},"created_at":{"type":"string","description":"created at datetime 2024-09-20T15:59:59.100-04:00"},"updated_at":{"type":"string","description":"date last updated 2024-09-20T15:59:59.100-04:00"},"user_id:":{"type":"integer","description":"associated user to api key"}},"description":"ApiKey resource"},"ApiKeySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ApiKey"}}}],"description":"ApiKey specification"},"ApiKeyCreateSpec":{"type":"object","properties":{"name":{"type":"string","description":"name"},"expiry":{"type":"string","description":"2024-12-22T17:24:32.162-05:00 intended expiry"}},"description":"Api key creation specification"},"ApplicationCategory":{"type":"object","properties":{"name":{"type":"string","description":"Application name"},"description":{"type":"string","description":"Application description"}},"description":"ApplicationCategory resource"},"ApplicationCategorySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ApplicationCategory"}}}],"description":"ApplicaitonCategory specification"},"ApplicationCategoryCreate":{"type":"object","properties":{"name":{"type":"string","description":"Application category name"},"description":{"type":"string","description":"Application category description"}},"required":["name"],"description":"ApplicationCategory creation request parameters"},"ApplicationCategoryCreateSpec":{"type":"object","properties":{"application_category":{"$ref":"#/components/schemas/ApplicationCategoryCreate"}},"required":["application_category"],"description":"Category creation request parameters"},"Application":{"type":"object","properties":{"name":{"type":"string","description":"Application name"},"display_name":{"type":"string","description":"Application display name"},"description":{"type":"string","description":"Application description"},"home_page_url":{"type":"string","description":"Home page URL"},"favicon":{"type":"string","description":"Application favicon"},"icon":{"type":"string","description":"Application icon"}},"description":"Application resource"},"ApplicationLookup":{"type":"object","properties":{"id":{"type":"integer","description":"Application Id"},"name":{"type":"string","description":"Application name"},"category":{"type":"string","description":"Application category name"}},"description":"ApplicationLookup resource"},"ApplicationSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Application"},"relationships":{"type":"object","properties":{"categories":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Application categories"}}}],"description":"Application specification"},"AsyncSearchStatus":{"type":"object","properties":{"is_running":{"type":"boolean","description":"Whether the search is still running"},"timed_out":{"type":"boolean","description":"Whether the search timed out"},"succeeded":{"type":"boolean","description":"Whether the search succeeded in getting results"},"deleted":{"type":"boolean","description":"Whether the search was deleted"}},"description":"AsyncSearchStatus resource"},"AuthIdentity":{"type":"object","properties":{"id":{"type":"integer","description":"Auth Identity ID"},"user_id":{"type":"integer","description":"User ID"},"enterprise_connection_id":{"type":"integer","description":"Enterprise Connection ID"},"sub":{"type":"string","description":"Sub"},"provider":{"type":"string","description":"Provider"},"current":{"type":"boolean","description":"True if identity is current login"},"last_sign_in_at":{"type":"string","format":"date","description":"Last Sign In Date"},"created_at":{"type":"string","format":"date","description":"Creation Date"},"updated_at":{"type":"string","format":"date","description":"Updated Date"}},"description":"AuthIdentity resource"},"AuthIdentitySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/AuthIdentity"}}}],"description":"AuthIdentity specification"},"AuthenticationSyncTool":{"type":"object","properties":{"name":{"type":"string","description":"Sync tool friendly name"},"hostname":{"type":"string","description":"Sync tool machine hostname"},"version":{"type":"string","description":"Sync tool version"},"last_known_ip":{"type":"string","description":"Sync tool last known IP (may be null)"},"status":{"type":"string","description":"Sync tool status"},"last_sync":{"type":"string","format":"date","description":"Last time the sync tool was seen"}},"description":"Authentication Sync Tool resource"},"AuthenticationSyncToolSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/AuthenticationSyncTool"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"Authentication sync tool associated objects"}}}],"description":"Authentication sync tool specification"},"AuthenticationSyncToolCreate":{"type":"object","properties":{"name":{"type":"string","description":"Network name"},"organization_id":{"type":"integer","description":"Organization resource ID"}},"required":["name","organization_id"],"description":"Authentication Sync Tool request parameters"},"AuthenticationSyncToolCreateSpec":{"type":"object","properties":{"authentication_sync_tool":{"$ref":"#/components/schemas/AuthenticationSyncToolCreate"}},"required":["authentication_sync_tool"],"description":"Authentication Sync Tool creation request parameters"},"BillingCreate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"User organization ID"},"payment_token":{"type":"string","description":"Stripe token"}},"required":["organization_id","payment_token"],"description":"Billing creation request parameters"},"PaymentMethod":{"type":"object","properties":{"object":{"type":"string","description":"Payment method type (credit card, paypal, etc.)"},"address_city":{"type":"string","description":"City"},"address_country":{"type":"string","description":"Country"},"address_line1":{"type":"string","description":"Address line 1"},"address_line2":{"type":"string","description":"Address line 2"},"address_state":{"type":"string","description":"State"},"address_zip":{"type":"string","description":"Address ZIP code"},"brand":{"type":"string","description":"Brand"},"country":{"type":"string","description":"Country associated with the payment method"},"exp_month":{"type":"integer","description":"Expiration month"},"exp_year":{"type":"integer","description":"Expiration year"},"last4":{"type":"string","description":"Last four digits"}},"description":"Payment method resource"},"Billing_BillingAddress":{"type":"object","properties":{"first_name":{"type":"string","description":"First Name"},"last_name":{"type":"string","description":"Last Name"},"email":{"type":"string","description":"Email"},"company":{"type":"string","description":"Company"},"phone":{"type":"string","description":"Phone"},"line1":{"type":"string","description":"Address Line1"},"line2":{"type":"string","description":"Address Line2"},"line3":{"type":"string","description":"Address Line3"},"city":{"type":"string","description":"City"},"state_code":{"type":"string","description":"The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India."},"state":{"type":"string","description":"State"},"zip":{"type":"string","description":"Zip or postal code"},"country":{"type":"string","description":"Country Must be one of ISO 3166 alpha-2 country code."}},"description":"Billing address resource"},"Billing_BillingAddressUpdateSpec":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/Billing_BillingAddress"}},"required":["billing_address"],"description":"Billing address update request parameters"},"BlockPage":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"organization_id":{"type":"integer","description":"The organization that owns the block page"},"block_org_name":{"type":"string","description":"The name of the organization to show on the block page. (may be null)"},"block_email_addr":{"type":"string","description":"The contact email address to show (may be null)"},"block_logo_uuid":{"type":"string","description":"The UUID of the custom logo uploaded to uploadcare.com (may be null)"},"created_at":{"type":"string","format":"date","description":"The block page created date"},"updated_at":{"type":"string","format":"date","description":"The last updated date of the block page"}},"description":"Represents a custom block page"},"Category":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"source":{"type":"string","description":"Source"},"security":{"type":"boolean","description":"It is classified as a security threat"},"internal":{"type":"boolean","description":"True if the category is used internally such as content servers or unknown categorizations"}},"description":"Category resource"},"CategorySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Category"},"relationships":{"type":"object","properties":{"child_categories":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}},"parent_categories":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Category hierarchy"}}}],"description":"Category specification"},"CategoryCreate":{"type":"object","properties":{"source":{"type":"string","enum":["dnsfilter","urlblacklist","webshrinker"],"description":"Category source"},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"}},"required":["source","name"],"description":"Category creation request parameters"},"CategoryCreateSpec":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryCreate"}},"required":["category"],"description":"Category creation request parameters"},"Collection":{"type":"object","properties":{"name":{"type":"string","description":"Collection name"},"organization_id":{"type":"integer","description":"Collection organization ID"},"policy_id":{"type":"integer","description":"Assigned policy ID (may be null)"},"scheduled_policy_id":{"type":"integer","description":"Assigned scheduled policy ID (may be null)"},"block_page_id":{"type":"integer","description":"Assigned block page ID (may be null)"},"order":{"type":"integer","description":"Collection priority order"}},"description":"Collection resource"},"CollectionSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Collection"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"Collection associated objects"}}}],"description":"Collection specification"},"CollectionCreate":{"type":"object","properties":{"name":{"type":"string","description":"Collection name"},"organization_id":{"type":"integer","description":"Organization resource ID"},"policy_id":{"type":"integer","description":"Collection policy ID"},"scheduled_policy_id":{"type":"integer","description":"Collection custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"Collection custom block page ID"},"order":{"type":"integer","description":"Collection order"}},"required":["organization_id"],"description":"Network creation request parameters"},"CollectionCreateSpec":{"type":"object","properties":{"network":{"$ref":"#/components/schemas/CollectionCreate"}},"required":["network"],"description":"Collection creation request parameters"},"CollectionUserCreateSpec":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"id":{"type":"integer","description":"User ID"}},"required":["collection_id","id"],"description":"Collection User creation request parameters"},"CollectionUserSpec":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/CollectionUserCreateSpec"}},"required":["policy"],"description":"Collection creation request parameters"},"SyncToolCollection":{"type":"object","properties":{"name":{"type":"string","description":"name"},"distinguished_name":{"type":"string","description":"distinguished name"},"organization_id":{"type":"integer","description":"organization ID"},"remote_id":{"type":"integer","description":"remote id of sync tool"},"parent_id":{"type":"integer","description":"parent collection id (may be null)"},"first_sync":{"type":"string","format":"date","description":"first sync timestamp. e.g: 2024-08-09T15:18:56.769-04:00 (may be null)"},"last_sync":{"type":"string","format":"date","description":"last sync timestamp. e.g: 2024-08-09T15:18:56.769-04:00 (may be null)"},"created_at":{"type":"string","format":"date","description":"creation date timestamp. e.g: 2024-08-09T15:18:56.769-04:00"},"updated_at":{"type":"string","format":"date","description":"last updated timestamp. e.g: 2024-08-09T15:18:56.769-04:00"}},"description":"SyncToolCollection resource"},"SyncToolCollectionSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/SyncToolCollection"}}}],"description":"SyncToolCollection specification"},"SyncToolGroup":{"type":"object","properties":{"name":{"type":"string","description":"name"},"distinguished_name":{"type":"string","description":"distinguished name"},"organization_id":{"type":"integer","description":"organization ID"},"remote_id":{"type":"integer","description":"remote id of sync tool"},"first_sync":{"type":"string","format":"date","description":"first sync timestamp. e.g: 2024-08-09T15:18:56.769-04:00 (may be null)"},"last_sync":{"type":"string","format":"date","description":"last sync timestamp. e.g: 2024-08-09T15:18:56.769-04:00 (may be null)"},"created_at":{"type":"string","format":"date","description":"creation date timestamp. e.g: 2024-08-09T15:18:56.769-04:00"},"updated_at":{"type":"string","format":"date","description":"last updated timestamp. e.g: 2024-08-09T15:18:56.769-04:00"}},"description":"SyncToolGroup resource"},"SyncToolGroupSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/SyncToolGroup"}}}],"description":"SyncToolGroup specification"},"CollectionsV2Spec":{"type":"object","properties":{"id":{"type":"integer","description":"Collection ID."},"attributes":{"$ref":"#/components/schemas/CollectionAttributesV2Spec"}},"description":"Collection Resource Specification"},"CollectionAttributesV2Spec":{"type":"object","properties":{"name":{"type":"string","description":"Collection name."},"description":{"type":"string","description":"Collection description (may be null)."},"organization_id":{"type":"integer","description":"Organization ID."},"policy_id":{"type":"integer","description":"Assigned policy ID (may be null)."},"scheduled_policy_id":{"type":"integer","description":"Assigned scheduled policy ID (may be null)."},"block_page_id":{"type":"integer","description":"Assigned block page ID (may be null)."},"sync_tool_collection_ids":{"type":"array","items":{"type":"integer"},"description":"Deprecated (use selected_objects): List of Sync Tool Collection IDs."},"sync_tool_group_ids":{"type":"array","items":{"type":"integer"},"description":"Deprecated (use selected_objects): List of Sync Tool Group IDs."},"is_manual":{"type":"boolean","description":"Is manual collection."},"order":{"type":"integer","description":"Collection order of precedence."},"selected_objects":{"$ref":"#/components/schemas/SelectedObjectsSpec"}},"description":"Collection Attributes Specification"},"CollectionIndexV2Spec":{"type":"object","properties":{"id":{"type":"integer","description":"Collection ID."},"attributes":{"$ref":"#/components/schemas/CollectionIndexAttributesV2Spec"}},"description":"Collection Resource (index). selected_objects contains counts rather than\nfull ID arrays. Use GET /v2/collections/:id for the full detail shape."},"CollectionIndexAttributesV2Spec":{"type":"object","properties":{"name":{"type":"string","description":"Collection name."},"description":{"type":"string","description":"Collection description (may be null)."},"organization_id":{"type":"integer","description":"Organization ID."},"policy_id":{"type":"integer","description":"Assigned policy ID (may be null)."},"scheduled_policy_id":{"type":"integer","description":"Assigned scheduled policy ID (may be null)."},"block_page_id":{"type":"integer","description":"Assigned block page ID (may be null)."},"sync_tool_collection_ids":{"type":"array","items":{"type":"integer"},"description":"Deprecated (use selected_objects): List of Sync Tool Collection IDs."},"sync_tool_group_ids":{"type":"array","items":{"type":"integer"},"description":"Deprecated (use selected_objects): List of Sync Tool Group IDs."},"is_manual":{"type":"boolean","description":"Is manual collection."},"order":{"type":"integer","description":"Collection order of precedence."},"created_at":{"type":"string","description":"ISO 8601 timestamp of when the collection was created."},"updated_at":{"type":"string","description":"ISO 8601 timestamp of when the collection was last updated."},"selected_objects":{"$ref":"#/components/schemas/SelectedObjectsIndexSpec"}},"description":"Collection Attributes (index)."},"CollectionsMetaSpec":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of collections."},"total_pages":{"type":"integer","description":"Total number of pages."},"current_page":{"type":"integer","description":"Current page number."}},"description":"Pagination metadata for Collections List"},"CollectionV2CreateSpec":{"type":"object","properties":{"name":{"type":"string","description":"Collection name."},"description":{"type":"string","description":"Collection description (may be null)."},"organization_id":{"type":"integer","description":"Organization ID."},"policy_id":{"type":"integer","description":"Assigned policy ID (may be null)."},"scheduled_policy_id":{"type":"integer","description":"Assigned scheduled policy ID (may be null)."},"block_page_id":{"type":"integer","description":"Assigned block page ID (may be null)."},"selected_objects":{"$ref":"#/components/schemas/SelectedObjectsSpec"}},"required":["name"],"description":"Collections creation payload."},"SelectedObjectsSpec":{"type":"object","properties":{"sync_tools":{"type":"array","items":{"$ref":"#/components/schemas/SyncToolSelectedObjectSpec"}},"identity_connections":{"type":"array","items":{"$ref":"#/components/schemas/CommonSelectedObjectSpec"}},"roaming_clients":{"type":"array","items":{"$ref":"#/components/schemas/CommonSelectedObjectSpec"}}},"description":"Collection selected objects (full detail, returned by GET /v2/collections/:id)."},"SelectedObjectsIndexSpec":{"type":"object","properties":{"identity_connections":{"$ref":"#/components/schemas/SelectedObjectsCountsSourceSpec"},"sync_tools":{"$ref":"#/components/schemas/SelectedObjectsCountsSourceSpec"},"roaming_clients":{"$ref":"#/components/schemas/SelectedObjectsCountsRoamingClientsSpec"}},"description":"Collection selected objects summary (returned by GET /v2/collections).\nContains aggregate counts instead of individual ID arrays."},"SelectedObjectsCountsSourceSpec":{"type":"object","properties":{"ids":{"type":"array","items":{"$ref":"#/components/schemas/SelectedObjectsCountsIdSpec"},"description":"Configured sources with their names."},"total_groups":{"type":"integer","description":"Total number of selected groups across all sources."},"total_users":{"type":"integer","description":"Total number of selected users across all sources."}},"description":"Aggregate summary for identity connections or sync tools."},"SelectedObjectsCountsIdSpec":{"type":"object","properties":{"id":{"type":"string","description":"Source ID (identity connection ID or root sync tool collection ID)."},"name":{"type":"string","description":"Source name."}},"description":"A source entry within the counts summary."},"SelectedObjectsCountsRoamingClientsSpec":{"type":"object","properties":{"total_users":{"type":"integer","description":"Total number of selected roaming client users."}},"description":"Aggregate summary for roaming clients."},"CommonSelectedObjectSpec":{"type":"object","properties":{"id":{"type":"string","description":"ID of the selected objects source."},"users":{"type":"array","items":{"$ref":"#/components/schemas/CommonSelectedObjectUserSpec"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CommonSelectedObjectGroupSpec"}}},"description":"Selected objects."},"SyncToolSelectedObjectSpec":{"type":"object","properties":{"id":{"type":"string","description":"ID of the selected objects source"},"users":{"type":"array","items":{"$ref":"#/components/schemas/CommonSelectedObjectUserSpec"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SyncToolSelectedObjectGroupSpec"}}},"description":"Sync Tool Selected objects."},"CommonSelectedObjectUserSpec":{"type":"object","properties":{"id":{"type":"string","description":"ID of the selected user."}},"description":"Selected Users."},"CommonSelectedObjectGroupSpec":{"type":"object","properties":{"id":{"type":"string","description":"ID of the selected group."}},"description":"Selected Groups."},"SyncToolSelectedObjectGroupSpec":{"type":"object","properties":{"id":{"type":"string","description":"ID of the selected object."},"group_type":{"type":"string","enum":["group","collection"],"description":"Type of the Sync Tool Group."}},"description":"Sync Tool Selected Groups."},"BulkDeleteCollectionSpec":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"}}},"description":"Payload for bulk-deleting collections."},"BulkUpdateCollectionSpec":{"type":"object","properties":{"policy_id":{"type":"integer"},"block_page_id":{"type":"integer"}},"description":"Payload for bulk-updating collections."},"BulkCollectionActionIndividualResultSpec":{"type":"object","properties":{"id":{"type":"integer"},"success":{"type":"boolean"}},"description":"Response payload for bulk actions."},"BulkCollectionActionResultSpec":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkCollectionActionIndividualResultSpec"}}},"description":"Response payload for bulk actions."},"LicenseWarningSuppressionData":{"type":"object","properties":{"warning_suppress_date":{"type":"string","description":"Warning suppression date"},"organization_uuid":{"type":"string","description":"Organization UUID"},"user_uuid":{"type":"string","description":"User UUID"}},"description":"Payload for License Warning Suppression Data"},"UserUiSetting":{"type":"object","properties":{"disable_license_warnings":{"type":"boolean","description":"Disables license warnings"},"user_uuid":{"type":"string","description":"User UUID"},"theme_mode":{"type":"string","description":"UI color theme preference. Allowed values: light, dark, system. Defaults to system."}},"description":"Payload for User UI settings"},"CyberSightActivityType":{"type":"object","properties":{"id":{"type":"integer","description":"Activity type ID"},"name":{"type":"string","description":"The name of the activity type"},"friendly_name":{"type":"string","description":"The friendly/display name that can be shown to the user"},"description":{"type":"string","description":"Simple description of the activity"}},"description":"Activity Types"},"CyberSightReportActivityLogRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including app_executable_path, app_name, app_window_title, web_full_url, web_host (minimum 2 characters)"},"app_executable_path":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_window_title":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"oneOf":[{"$ref":"#/components/schemas/ArrayIntegerIsOp"},{"type":"array","items":{"type":"integer"}},{"type":"string"}]},"category_ids":{"oneOf":[{"$ref":"#/components/schemas/ArrayIntegerIsOp"},{"type":"string"},{"type":"array","items":{"type":"integer"}}],"description":"strings should be comma delimited integers"},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"threats_only":{"type":"boolean","description":"When true, only events with threat categories are returned."},"ai_tool":{"type":"string","enum":["all","app","web"],"description":"When all, will return both app and web ai tools."},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"sort_by":{"type":"string","enum":["app_name","cyber_sight_service_version","event_duration","event_end_at","event_start_at","remote_ip","web_host"],"description":"default is event_start_at"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"}},"description":"Cyber Sight Report Activity Log Request"},"CyberSightReportActivityLogResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportActivityLogResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportActivityLogResponseDatum"}}},"description":"Cyber Sight Report Activity Log Response"},"CyberSightReportActivityLogResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}}},"description":"Cyber Sight Report Activity Log Response Meta"},"CyberSightReportActivityLogResponseDatum":{"type":"object","properties":{"activity_type_id":{"type":"integer"},"agent_local_user_id":{"type":"integer"},"agent_local_user_uuid":{"type":"string","description":"format:uuidv7"},"agent_local_user_user_name":{"type":"string"},"ai_tool":{"type":"string","enum":["app","web"]},"app_executable_path":{"type":"string"},"app_name":{"type":"string"},"app_window_title":{"type":"string"},"category_ids":{"type":"array","items":{"type":"integer"}},"event_duration":{"type":"integer","description":"unit:seconds"},"event_end_at":{"type":"string","description":"format:iso8601"},"event_start_at":{"type":"string","description":"format:iso8601"},"id":{"type":"string","description":"A unique identifier for this record"},"is_threat":{"type":"boolean","description":"true / false / null — whether the record's category_ids overlap Category::THREAT_IDS; null when the record has no categories"},"msp_id":{"type":"integer"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_id":{"type":"string"},"org_uuid":{"type":"string","description":"format:uuidv7"},"privacy_setting":{"type":"string","enum":["standard","identify_devices","maximum"]},"remote_ip":{"type":"string"},"user_agent_friendly_name":{"type":"string"},"user_agent_hostname":{"type":"string"},"user_agent_id":{"type":"string","description":"format:uuidv4"},"user_agent_uuid":{"type":"string","description":"format:uuidv7"},"web_full_url":{"type":"string"}},"description":"Cyber Sight Report Activity Log Response Datum"},"CyberSightReportAIUsageOverTimeRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"ai_tool":{"type":"string","enum":["all","web","app"],"description":"The AI tool type to query."},"q":{"type":"string","description":"Search multiple fields at once including app_executable_path, app_name, app_window_title, web_full_url, web_host (minimum 2 characters)"},"app_executable_path":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_window_title":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}}},"CyberSightReportAIUsageOverTimeResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportAIUsageOverTimeBucket"}}}},"CyberSightReportAIUsageOverTimeBucket":{"type":"object","properties":{"date":{"type":"string","description":"Datetime, may be start of day, start of hour, or start of minute."},"total_events":{"type":"integer","description":"Number of individual events for the given date"},"total_time_in_seconds":{"type":"integer","description":"Total time in seconds for the given date."}}},"CyberSightReportPendingResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportPendingResponseMeta"}},"description":"Cyber Sight Report Pending Response"},"CyberSightReportPendingResponseMeta":{"type":"object","properties":{"search_id":{"type":"string","description":"Async search continuation token. Pass back as the `search_id` request parameter to retrieve completed results."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor. Pass back unchanged on the next request to fetch the page after the current one."}},"description":"Cyber Sight Report Pending Response Meta"},"CyberSightReportEventCountHistogramRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Event Count Histogram Request"},"CyberSightReportEventCountHistogramResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportEventCountHistogramResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportEventCountHistogramBucket"}}},"description":"Cyber Sight Report Event Count Histogram Response"},"CyberSightReportEventCountHistogramResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_time_in_seconds":{"type":"number","description":"Total time spent across all events in seconds"}},"description":"Cyber Sight Report Event Count Histogram Response Meta"},"CyberSightReportEventCountHistogramBucket":{"type":"object","properties":{"timestamp":{"type":"string","description":"The start time of this bucket"},"interval":{"type":"string","description":"The bucket duration, one of \"15m\", \"1h\", or \"1d\" depending on the total time range of the report"},"event_counts":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportEventCountHistogramEventCount"},"description":"The event type breakdown for this bucket"}},"description":"Cyber Sight Report Event Count Histogram Bucket"},"CyberSightReportEventCountHistogramEventCount":{"type":"object","properties":{"event_type":{"type":"string","description":"The event type, one of \"app\", \"web\", or \"streaming\""},"count":{"type":"integer","description":"The count of documents in this bucket for the event type"},"time_in_seconds":{"type":"number","description":"Total time in seconds for this event type in this bucket"}},"description":"Cyber Sight Report Event Count Histogram Event Count"},"CyberSightReportObservedThreatTrendRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"app_name":{"type":"string"},"app_window_title":{"type":"string"},"web_full_url":{"type":"string"},"web_host":{"type":"string"},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Observed Threat Trend Request"},"CyberSightReportObservedThreatTrendResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportObservedThreatTrendResponseMeta"},"data":{"$ref":"#/components/schemas/CyberSightReportObservedThreatTrendResponseData"}},"description":"Cyber Sight Report Observed Threat Trend Response"},"CyberSightReportObservedThreatTrendResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"}},"description":"Cyber Sight Report Observed Threat Trend Response Meta"},"CyberSightReportObservedThreatTrendResponseData":{"type":"object","properties":{"aggregations":{"$ref":"#/components/schemas/CyberSightReportObservedThreatTrendAggregations"}},"description":"Cyber Sight Report Observed Threat Trend Response Data"},"CyberSightReportObservedThreatTrendAggregations":{"type":"object","properties":{"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"},"event_histogram":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportObservedThreatBucket"}}},"description":"Cyber Sight Report Observed Threat Trend Aggregations"},"CyberSightReportObservedThreatBucket":{"type":"object","properties":{"date":{"type":"string","description":"The start time of this bucket"},"type":{"type":"string","description":"The type of bucket, either \"hour\" or \"day\" depending on the total time range of the report"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportObservedThreatCategoryBucket"},"description":"The formatted category ID and count of documents hit"},"users":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportObservedThreatAgentLocalUserBucket"},"description":"The formatted agent_local_user_id and count of documents hit"}},"description":"Cyber Sight Report Observed Threat Bucket"},"CyberSightReportObservedThreatCategoryBucket":{"type":"object","properties":{"category":{"type":"string","description":"The category ID"},"count":{"type":"number","description":"The count of documents hit"}},"description":"Cyber Sight Report Observed Threat Category Bucket"},"CyberSightReportObservedThreatAgentLocalUserBucket":{"type":"object","properties":{"user_id":{"type":"string","description":"The agent_local_user_id"},"count":{"type":"number","description":"The count of documents hit"}},"description":"Cyber Sight Report Observed Threat Agent Local User Bucket"},"CyberSightReportTopActiveClientsRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"app_name":{"type":"string"},"app_window_title":{"type":"string"},"web_full_url":{"type":"string"},"web_host":{"type":"string"},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:10 maximum:40000"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Active Client Request"},"CyberSightReportTopActiveClientsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopActiveClientsResponseMeta"},"data":{"$ref":"#/components/schemas/CyberSightReportTopActiveClientsResponseData"}},"description":"Cyber Sight Report Top Active Client Response"},"CyberSightReportTopActiveClientsResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct roaming clients with activity, independent of `size`. All `privacy_setting=maximum` events collapse into a single redacted bucket and contribute 1 to this count — matching the single redacted row the report renders for that group. Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Active Client Response Meta"},"CyberSightReportTopActiveClientsResponseData":{"type":"object","properties":{"aggregations":{"$ref":"#/components/schemas/CyberSightReportTopActiveClientsAggregations"}},"description":"Cyber Sight Report Top Active Clients Response Data"},"CyberSightReportTopActiveClientsAggregations":{"type":"object","properties":{"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"},"user_agent_uuid_buckets":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopActiveClientBucket"}}},"description":"Cyber Sight Report Top Active Clients Aggregations"},"CyberSightReportTopActivitiesRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:10"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Activities Request"},"CyberSightReportTopActivitiesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopActivitiesResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopActivitiesActivityBucket"}}},"description":"Cyber Sight Report Top Activities Response"},"CyberSightReportTopActivitiesResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_activities_time_in_seconds":{"type":"number","description":"Total time spent across all activity types in seconds"}},"description":"Cyber Sight Report Top Activities Response Meta"},"CyberSightReportTopActivitiesActivityBucket":{"type":"object","properties":{"name":{"type":"string","description":"The activity name (app_name for app/streaming, web_host for web)"},"event_type":{"type":"string","description":"The event type (app, streaming, or web)"},"time_in_seconds":{"type":"number","description":"Total time spent on this activity in seconds"},"percent_time":{"type":"number","description":"Percentage of total activity time spent on this entry"}},"description":"Cyber Sight Report Top Activities Activity Bucket\nRepresents a single activity entry coalesced across app, streaming, and web event types"},"CyberSightReportTopAIActiveClientsRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:10"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top AI Active Clients Request\n\nReturns AI usage (combined web + app) summarized per roaming client.\nNo additional filter attributes — the report is unfiltered by design (use\nthe existing base filters for org, time range, etc.)."},"CyberSightReportTopAIActiveClientsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopAIActiveClientsResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopAIActiveClientsRow"}}}},"CyberSightReportTopAIActiveClientsResponseMeta":{"type":"object","properties":{"count":{"type":"integer","description":"Number of buckets returned in this response (≤ requested size)"},"total_count":{"type":"integer","description":"Total matching event documents (not distinct entities)"},"search_after":{"type":"array","items":{"type":"object"}},"total_ai_time_in_seconds":{"type":"number","description":"Total time across all AI events in scope"},"total_unique_count":{"type":"integer","description":"Total distinct roaming clients with AI activity, independent of size. All privacy_setting=maximum events collapse into a single redacted bucket and contribute 1 to this count. Approximate above 40,000 distinct values (HyperLogLog)."}}},"CyberSightReportTopAIActiveClientsRow":{"type":"object","properties":{"user_agent_uuid":{"type":"string","description":"Roaming client uuid (or redacted placeholder)"},"hostname":{"type":"string","description":"Friendly name / hostname (or redacted placeholder)"},"agent_local_user_count_unique":{"type":"integer","description":"Distinct users on this client with AI activity"},"event_count":{"type":"integer","description":"Total AI events on this client (web + app combined)"},"time_in_seconds":{"type":"number","description":"Total AI time on this client (web + app combined)"},"percent_time":{"type":"number","description":"This client's % of org-wide total AI time"}},"description":"One row per roaming client. All privacy_setting=maximum events condense into\na single row with both user_agent_uuid and hostname showing the redacted\nplaceholder string."},"CyberSightReportTopAIUsageRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"ai_tool":{"type":"string","enum":["all","web","app","client"],"description":"The AI tool type to query. \"web\" for AI websites, \"app\" for AI applications, \"all\" for a combined web+app row list keyed by website or application, \"client\" for combined AI usage per roaming client."},"q":{"type":"string","description":"Search multiple fields at once including app_executable_path, app_name, app_window_title, web_full_url, web_host (minimum 2 characters)"},"app_executable_path":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_window_title":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:10"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"required":["ai_tool"],"description":"Cyber Sight Report Top AI Usage Request"},"CyberSightReportTopAIUsageResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopAIUsageResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopAIUsageBucket"}}},"description":"Cyber Sight Report Top AI Usage Response"},"CyberSightReportTopAIUsageResponseMeta":{"type":"object","properties":{"count":{"type":"integer","description":"Number of buckets returned in this response (≤ requested size)"},"total_count":{"type":"integer","description":"Total matching event documents (not distinct entities)"},"search_after":{"type":"array","items":{"type":"object"}},"total_ai_time_in_seconds":{"type":"number","description":"Total time spent on all AI activity in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct entities matching the query, independent of size. The dimension counted depends on ai_tool: distinct web hosts (web), distinct app names (app), distinct script-derived web/app entities (all), distinct roaming clients (client). Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top AI Usage Response Meta"},"CyberSightReportTopAIUsageBucket":{"type":"object","properties":{"web_host":{"type":"string","description":"The AI website hostname (present when ai_tool is web)"},"application":{"type":"string","description":"The AI application name (present when ai_tool is app)"},"ai_tool":{"type":"string","description":"The website hostname or application name for this row (present when ai_tool is all)"},"user_agent_uuid":{"type":"string","description":"Roaming client UUID or redacted placeholder (present when ai_tool is client)"},"hostname":{"type":"string","description":"Roaming client friendly name or hostname, or redacted placeholder (present when ai_tool is client)"},"activity_count":{"type":"integer","description":"Number of events (present when ai_tool is web, app, or all)"},"user_agent_count_unique":{"type":"integer","description":"Number of unique roaming clients (present when ai_tool is web, app, or all)"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users"},"time_in_seconds":{"type":"number","description":"Total time spent on this AI tool or client in seconds"},"percent_time":{"type":"number","description":"Percentage of total AI time"},"web_category_ids":{"type":"object","description":"Web category ids for the row. Present when ai_tool is web or all. For ai_tool=web, an array of integer category ids (hidden categories such as CTIRU and MANDATED are filtered out). For ai_tool=all, an array of integer category ids on website rows and an empty string (\"\") on application rows."}},"description":"Cyber Sight Report Top AI Usage Bucket\n\nThe bucket shape varies by ai_tool:\n\nWhen ai_tool is \"web\": one row per AI website.\n  Fields: web_host, activity_count, user_agent_count_unique, agent_local_user_count_unique, time_in_seconds, percent_time, web_category_ids\n\nWhen ai_tool is \"app\": one row per AI application.\n  Fields: application, activity_count, user_agent_count_unique, agent_local_user_count_unique, time_in_seconds, percent_time\n\nWhen ai_tool is \"all\": one row per AI website or AI application, keyed by web_host or app_name.\n  Fields: ai_tool, activity_count, user_agent_count_unique, agent_local_user_count_unique, time_in_seconds, percent_time, web_category_ids\n  web_category_ids is an array of category ids for website rows and an empty string (\"\") for application rows.\n\nWhen ai_tool is \"client\": one row per roaming client (combined web + app AI activity).\n  Fields: user_agent_uuid, hostname, agent_local_user_count_unique, time_in_seconds, percent_time\n  Privacy: privacy_setting=maximum events are condensed into a single row with redacted placeholders."},"CyberSightReportTopAIUsageUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"ai_tool":{"type":"string","enum":["web","app","client"],"description":"Which drilldown to perform"},"q":{"type":"string","description":"Search multiple fields at once including app_executable_path, app_name, app_window_title, web_full_url, web_host (minimum 2 characters)"},"app_executable_path":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}],"description":"Optional substring filter (app mode only)"},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}],"description":"Required when ai_tool is \"app\""},"app_window_title":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}],"description":"Optional substring filter (app mode only)"},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}],"description":"Optional substring filter (web mode only)"},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}],"description":"Required when ai_tool is \"web\""},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 Required (one element) when ai_tool is \"client\""},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:10"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"required":["ai_tool"],"description":"Cyber Sight Report Top AI Usage Users Request\n\nThree modes via `ai_tool`:\n  - \"web\"    requires `web_host`             — users of one AI website\n  - \"app\"    requires `app_name`             — users of one AI application\n  - \"client\" requires `user_agent_uuids` (array of one)\n                                             — users of one roaming client\n                                               (combined web + app AI activity)"},"CyberSightReportTopAIUsageUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopAIUsageUsersResponseMeta"},"data":{"type":"array","items":{"type":"object"},"description":"Rows shaped per ai_tool — see CyberSightReportTopAIUsageUsersWebAppRow and CyberSightReportTopAIUsageUsersClientRow"}},"description":"Cyber Sight Report Top AI Usage Users Response"},"CyberSightReportTopAIUsageUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer","description":"Number of rows returned in this response (≤ requested size)"},"total_count":{"type":"integer","description":"Total matching event documents (not distinct rows)"},"search_after":{"type":"array","items":{"type":"object"}},"total_ai_time_in_seconds":{"type":"number","description":"Total time across all matching AI events"},"total_unique_count":{"type":"integer","description":"Total distinct rows matching the query, independent of size. For ai_tool web/app: distinct user-RC pairs across standard and identify_devices, plus 1 for the collapsed maximum row when present. For ai_tool client: distinct users on the targeted roaming client, plus 1 for the collapsed identify_devices row when present. Approximate above 40,000 distinct values (HyperLogLog)."}}},"CyberSightReportTopAIUsageUsersWebAppRow":{"type":"object","properties":{"user":{"type":"string","description":"Display name (friendly_name or user_name) or redacted placeholder"},"rc":{"type":"string","description":"Roaming client display name (friendly_name or hostname) or redacted placeholder"},"user_uuid":{"type":"string","description":"Agent local user uuid (null when redacted)"},"rc_uuid":{"type":"string","description":"Roaming client uuid (null when redacted for maximum privacy)"},"number_of_events":{"type":"integer"},"total_time":{"type":"number","description":"Total time on this AI site/app for this user-RC pair"},"percent_usage_all_users":{"type":"number","description":"This row's % of all users' time on this AI site/app"},"percent_usage_for_user":{"type":"number","description":"This site/app's % of this user's total AI usage in scope"}},"description":"Returned when ai_tool is \"web\" or \"app\". One row per user-RC pair.\nPrivacy redaction:\n  - standard         → user and rc are populated\n  - identify_devices → user shows redacted placeholder; user_uuid is null\n  - maximum          → both user and rc show redacted placeholder; both uuids are null"},"CyberSightReportTopAIUsageUsersClientRow":{"type":"object","properties":{"user":{"type":"string","description":"Display name or redacted placeholder"},"user_uuid":{"type":"string","description":"Agent local user uuid (null when redacted)"},"number_of_events":{"type":"integer"},"total_time":{"type":"number","description":"Total AI time for this user on the targeted client"},"percent_activity":{"type":"number","description":"This user's % of the client's total AI activity"}},"description":"Returned when ai_tool is \"client\". One row per user on the targeted client.\nPrivacy redaction:\n  - standard         → user is populated\n  - identify_devices → condensed into a single redacted row\n  - maximum          → excluded (the targeted RC was redacted in TopAIActiveClients)"},"CyberSightReportTopApplicationsRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including app_executable_path, app_name, app_window_title (minimum 2 characters)"},"app_executable_path":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"app_window_title":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Applications Request"},"CyberSightReportTopApplicationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopApplicationsResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopApplicationsApplicationBucket"}}},"description":"Cyber Sight Report Top Applications Response"},"CyberSightReportTopApplicationsResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_application_time_in_seconds":{"type":"number","description":"Total time spent on all applications in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct application names matching the query, independent of `size`. Use this to detect when there are more results than the bucket size returns (`total_unique_count \u003e count`). Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Applications Response Meta"},"CyberSightReportTopApplicationsResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Applications Response Data\nRepresents an array of CyberSightReportTopApplicationsApplicationBucket"},"CyberSightReportTopApplicationsApplicationBucket":{"type":"object","properties":{"application":{"type":"string","description":"The application name"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users who used this application"},"application_focus_in_seconds":{"type":"number","description":"Total time spent on this application in seconds"},"percent_time":{"type":"number","description":"Percentage of total application time spent on this application"}},"description":"Cyber Sight Report Top Applications Application Bucket"},"CyberSightReportTopApplicationsUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including app_name (minimum 2 characters)"},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Applications Users Request"},"CyberSightReportTopApplicationsUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopApplicationsUsersResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopApplicationsUsersUserBucket"}}},"description":"Cyber Sight Report Top Applications Users Response"},"CyberSightReportTopApplicationsUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_application_time_in_seconds":{"type":"number","description":"Total time spent on the filtered application in seconds"}},"description":"Cyber Sight Report Top Applications Users Response Meta"},"CyberSightReportTopApplicationsUsersResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Applications Users Response Data\nRepresents an array of CyberSightReportTopApplicationsUsersUserBucket"},"CyberSightReportTopApplicationsUsersUserBucket":{"type":"object","properties":{"user":{"type":"string","description":"Display name for the agent local user (or redacted for maximum privacy)"},"rc":{"type":"string","description":"Hostname of the roaming client / user agent (or redacted for maximum privacy)"},"user_uuid":{"type":"string","description":"UUID of the agent local user (null for maximum-privacy rows)"},"rc_uuid":{"type":"string","description":"UUID of the user agent / roaming client (null for maximum-privacy rows)"},"number_of_events":{"type":"integer","description":"Number of activity events for this user on this client on the filtered application"},"total_time":{"type":"number","description":"Total time in seconds for this user on this client on the filtered application"},"percent_usage_all_users":{"type":"number","description":"Percentage of total time (all users) on the filtered application that was spent by this user on this client"},"percent_usage_for_user":{"type":"number","description":"Percentage of this user's total time across all applications spent on the filtered application"}},"description":"One row per (agent local user, roaming client) on the filtered application.\nMaximum-privacy rows have user and rc redacted and user_uuid/rc_uuid null."},"CyberSightReportTopCategoriesRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"threats_only":{"type":"boolean","description":"When true, restrict results to threat category IDs only"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Categories Request"},"CyberSightReportTopCategoriesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopCategoriesResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopCategoriesBucket"}}},"description":"Cyber Sight Report Top Categories Response"},"CyberSightReportTopCategoriesResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_category_time_in_seconds":{"type":"number","description":"Total time spent on all categories in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct category IDs matching the query, independent of `size`. Cardinality is on the multi-valued `web_categories` field, so a single event tagged with multiple categories contributes each tag once. When `threats_only=true`, the underlying docs are pre-filtered to those carrying at least one threat category, so this counts category IDs appearing on threat-tagged events. Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Categories Response Meta"},"CyberSightReportTopCategoriesResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Categories Response Data\nRepresents an array of CyberSightReportTopCategoriesBucket"},"CyberSightReportTopCategoriesBucket":{"type":"object","properties":{"category":{"type":"integer","description":"The category ID"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users who visited websites in this category"},"category_focus_in_seconds":{"type":"number","description":"Total time spent on websites in this category in seconds"},"percent_time":{"type":"number","description":"Percentage of total category time spent on this category"}},"description":"Cyber Sight Report Top Categories Bucket"},"CyberSightReportTopCategoriesUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"oneOf":[{"type":"array","items":{"type":"integer"}},{"type":"string"}],"description":"Category IDs to filter by"},"q":{"type":"string","description":"Search multiple fields at once including web_full_url, web_host (minimum 2 characters)"},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"required":["category_ids"],"description":"Cyber Sight Report Top Categories Users Request"},"CyberSightReportTopCategoriesUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopCategoriesUsersResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopCategoriesUsersUserBucket"}}},"description":"Cyber Sight Report Top Categories Users Response"},"CyberSightReportTopCategoriesUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_web_time_in_seconds":{"type":"number","description":"Total time spent on all websites in seconds"}},"description":"Cyber Sight Report Top Categories Users Response Meta"},"CyberSightReportTopCategoriesUsersResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Categories Users Response Data\nRepresents an array of CyberSightReportTopCategoriesUsersUserBucket"},"CyberSightReportTopCategoriesUsersUserBucket":{"type":"object","properties":{"user":{"type":"string","description":"Display name for the agent local user (or redacted for maximum privacy)"},"rc":{"type":"string","description":"Hostname of the roaming client / user agent (or redacted for maximum privacy)"},"user_uuid":{"type":"string","description":"UUID of the agent local user (null for maximum-privacy rows)"},"rc_uuid":{"type":"string","description":"UUID of the user agent / roaming client (null for maximum-privacy rows)"},"number_of_events":{"type":"integer","description":"Number of activity events for this user on this client in the filtered web categories"},"total_time":{"type":"number","description":"Total time in seconds for this user on this client in the filtered web categories"},"percent_usage_all_users":{"type":"number","description":"Percentage of total time (all users) in the filtered web categories that was spent by this user on this client"},"percent_usage_for_user":{"type":"number","description":"Percentage of this user's total time across all hosts spent in the filtered web categories"}},"description":"One row per (agent local user, roaming client) in the filtered web categories.\nMaximum-privacy rows have user and rc redacted and user_uuid/rc_uuid null."},"CyberSightReportTopRiskyUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"app_name":{"type":"string"},"app_window_title":{"type":"string"},"web_full_url":{"type":"string"},"web_host":{"type":"string"},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Risky User Request"},"CyberSightReportTopRiskyUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopRiskyUsersResponseMeta"},"data":{"$ref":"#/components/schemas/CyberSightReportTopRiskyUsersResponseData"}},"description":"Cyber Sight Report Top Risky User Response"},"CyberSightReportTopRiskyUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct users with threat-category activity, independent of `size`. Cardinality is on `agent_local_user_uuid` after the doc-level `web_categories ∈ THREAT_IDS` filter, so only users contributing to at least one threat event are counted. Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Risky User Response Meta"},"CyberSightReportTopRiskyUsersResponseData":{"type":"object","properties":{"aggregations":{"$ref":"#/components/schemas/CyberSightReportTopRiskyUsersAggregations"}},"description":"Cyber Sight Report Top Risky Users Response Data"},"CyberSightReportTopRiskyUsersAggregations":{"type":"object","properties":{"total_time_in_seconds":{"type":"number","description":"Total time spent on all active records in seconds"},"user_buckets":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopActiveClientBucket"}}},"description":"Cyber Sight Report Top Risky Users Aggregations"},"CyberSightReportTopActiveClientBucket":{"type":"object","properties":{"user_agent_uuid":{"type":"string","description":"The client user agent uuid"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users who used this client"},"time_in_seconds":{"type":"number","description":"Total time spent on this client in seconds"},"percent_time":{"type":"number","description":"Percentage of total time spent on this client"}},"description":"Cyber Sight Report Top Active Client Bucket"},"CyberSightReportTopStreamingRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including app_name (minimum 2 characters)"},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Streaming Applications Request"},"CyberSightReportTopStreamingResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopStreamingResponseMeta"},"data":{"$ref":"#/components/schemas/CyberSightReportTopStreamingResponseData"}},"description":"Cyber Sight Report Top Streaming Applications Response"},"CyberSightReportTopStreamingResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_streaming_time_in_seconds":{"type":"number","description":"Total time spent on all streaming applications in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct streaming application names matching the query, independent of `size`. Use this to detect when there are more results than the bucket size returns (`total_unique_count \u003e count`). Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Streaming Applications Response Meta"},"CyberSightReportTopStreamingResponseData":{"type":"object","properties":{"aggregations":{"$ref":"#/components/schemas/CyberSightReportTopStreamingAggregations"}},"description":"Cyber Sight Report Top Streaming Applications Response Data"},"CyberSightReportTopStreamingAggregations":{"type":"object","properties":{"total_streaming_time_in_seconds":{"type":"number","description":"Total time spent on all streaming applications in seconds"},"streaming_app_buckets":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopStreamingStreamingAppBucket"}}},"description":"Cyber Sight Report Top Streaming Applications Aggregations"},"CyberSightReportTopStreamingStreamingAppBucket":{"type":"object","properties":{"streaming_app_name":{"type":"string","description":"The streaming application name"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users who used this streaming application"},"streaming_app_focus_in_seconds":{"type":"number","description":"Total time spent on this streaming application in seconds"},"percent_time":{"type":"number","description":"Percentage of total streaming time spent on this application"}},"description":"Cyber Sight Report Top Streaming Applications Streaming App Bucket"},"CyberSightReportTopStreamingUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including app_name (minimum 2 characters)"},"app_name":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Streaming Users Request"},"CyberSightReportTopStreamingUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopStreamingUsersResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopStreamingUsersUserBucket"}}},"description":"Cyber Sight Report Top Streaming Users Response"},"CyberSightReportTopStreamingUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_application_time_in_seconds":{"type":"number","description":"Total time spent on the filtered application in seconds"}},"description":"Cyber Sight Report Top Streaming Users Response Meta"},"CyberSightReportTopStreamingUsersResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Streaming Users Response Data\nRepresents an array of CyberSightReportTopStreamingUsersUserBucket"},"CyberSightReportTopStreamingUsersUserBucket":{"type":"object","properties":{"user":{"type":"string","description":"Display name for the agent local user (or redacted for maximum privacy)"},"rc":{"type":"string","description":"Hostname of the roaming client / user agent (or redacted for maximum privacy)"},"user_uuid":{"type":"string","description":"UUID of the agent local user (null for maximum-privacy rows)"},"rc_uuid":{"type":"string","description":"UUID of the user agent / roaming client (null for maximum-privacy rows)"},"number_of_events":{"type":"integer","description":"Number of activity events for this user on this client on the filtered streaming application"},"total_time":{"type":"number","description":"Total time in seconds for this user on this client on the filtered streaming application"},"percent_usage_all_users":{"type":"number","description":"Percentage of total time (all users) on the filtered streaming application that was spent by this user on this client"},"percent_usage_for_user":{"type":"number","description":"Percentage of this user's total time across all streaming applications spent on the filtered application"}},"description":"One row per (agent local user, roaming client) on the filtered streaming application.\nMaximum-privacy rows have user and rc redacted and user_uuid/rc_uuid null."},"CyberSightReportTopWebsitesRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including web_full_url, web_host (minimum 2 characters)"},"web_full_url":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"default is desc"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"}},"description":"Cyber Sight Report Top Websites Request"},"CyberSightReportTopWebsitesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopWebsitesResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopWebsitesWebsiteBucket"}}},"description":"Cyber Sight Report Top Websites Response"},"CyberSightReportTopWebsitesResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_web_time_in_seconds":{"type":"number","description":"Total time spent on all websites in seconds"},"total_unique_count":{"type":"integer","description":"Total distinct web hosts matching the query, independent of `size`. Use this to detect when there are more results than the bucket size returns (`total_unique_count \u003e count`). Approximate above 40,000 distinct values (HyperLogLog)."}},"description":"Cyber Sight Report Top Websites Response Meta"},"CyberSightReportTopWebsitesResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Websites Response Data\nRepresents an array of CyberSightReportTopWebsitesWebsiteBucket"},"CyberSightReportTopWebsitesWebsiteBucket":{"type":"object","properties":{"web_host":{"type":"string","description":"The website hostname"},"agent_local_user_count_unique":{"type":"integer","description":"Number of unique users who visited this website"},"web_host_focus_in_seconds":{"type":"number","description":"Total time spent on this website in seconds"},"percent_time":{"type":"number","description":"Percentage of total website time spent on this website"}},"description":"Cyber Sight Report Top Websites Website Bucket"},"CyberSightReportTopWebsitesUsersRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"q":{"type":"string","description":"Search multiple fields at once including web_host (minimum 2 characters)"},"web_host":{"oneOf":[{"$ref":"#/components/schemas/StringMatchOp"},{"type":"string"}]},"activity_type_ids":{"type":"array","items":{"type":"integer"}},"category_ids":{"type":"array","items":{"type":"integer"}},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"size":{"type":"integer","description":"default:25"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"sort_direction":{"type":"string","description":"Sort direction for results (asc or desc)"}},"description":"Cyber Sight Report Top Websites Users Request"},"CyberSightReportTopWebsitesUsersResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CyberSightReportTopWebsitesUsersResponseMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportTopWebsitesUsersUserBucket"}}},"description":"Cyber Sight Report Top Websites Users Response"},"CyberSightReportTopWebsitesUsersResponseMeta":{"type":"object","properties":{"count":{"type":"integer"},"total_count":{"type":"integer"},"search_after":{"type":"array","items":{"type":"object"}},"total_web_time_in_seconds":{"type":"number","description":"Total time spent on all websites in seconds"}},"description":"Cyber Sight Report Top Websites Users Response Meta"},"CyberSightReportTopWebsitesUsersResponseData":{"type":"object","properties":{},"description":"Cyber Sight Report Top Websites Users Response Data\nRepresents an array of CyberSightReportTopWebsitesUsersUserBucket"},"CyberSightReportTopWebsitesUsersUserBucket":{"type":"object","properties":{"user":{"type":"string","description":"Display name for the agent local user (or redacted for maximum privacy)"},"rc":{"type":"string","description":"Hostname of the roaming client / user agent (or redacted for maximum privacy)"},"user_uuid":{"type":"string","description":"UUID of the agent local user (null for maximum-privacy rows)"},"rc_uuid":{"type":"string","description":"UUID of the user agent / roaming client (null for maximum-privacy rows)"},"number_of_events":{"type":"integer","description":"Number of activity events for this user on this client on the filtered web host"},"total_time":{"type":"number","description":"Total time in seconds for this user on this client on the filtered web host"},"percent_usage_all_users":{"type":"number","description":"Percentage of total time (all users) on the filtered web host that was spent by this user on this client"},"percent_usage_for_user":{"type":"number","description":"Percentage of this user's total time across all hosts spent on the filtered web host"}},"description":"One row per (agent local user, roaming client) on the filtered web host.\nMaximum-privacy rows have user and rc redacted and user_uuid/rc_uuid null."},"CyberSightReportUserTimelineRequest":{"type":"object","properties":{"search_id":{"type":"string","description":"Continuation token to retrieve a previously-started async search. When provided, start_at, end_at, msp_uuid, and org_uuids are not required; otherwise start_at, end_at, and one of msp_uuid or org_uuids are required."},"search_after":{"type":"array","items":{"type":"object"},"description":"Pagination cursor returned in the response meta; pass back unchanged to fetch the next page."},"start_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be within the last year."},"end_at":{"type":"string","description":"format:iso8601 Required when search_id is not provided. Must be greater than start_at. Max range is 91 days."},"weekdays_only":{"type":"boolean","description":"default:false"},"msp_uuid":{"type":"string","description":"format:uuidv7"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 The user agent UUIDs to build the timeline for"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 The agent local user UUIDs to build the timeline for"}},"required":["user_agent_uuids"]},"CyberSightReportUserTimelineResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimelineData"}}}},"CyberSightReportUserTimelineData":{"type":"object","properties":{"view_mode":{"type":"string","description":"Either \"single_day\" or \"multi_day\" depending on the requested date range"},"timelines":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimeline"}}}},"CyberSightReportUserTimeline":{"type":"object","properties":{"user_agent_uuid":{"type":"string","description":"format:uuidv7 The user agent UUID"},"agent_local_user_uuid":{"type":"string","description":"format:uuidv7 The agent local user UUID"},"events":{"$ref":"#/components/schemas/CyberSightReportUserTimelineEvents"},"total_time_in_seconds":{"$ref":"#/components/schemas/CyberSightReportUserTimelineTotalTimeInSeconds"}}},"CyberSightReportUserTimelineTotalTimeInSeconds":{"type":"object","properties":{"active":{"type":"integer","description":"Total time in seconds for event types \"app\" and \"web\""},"streaming":{"type":"integer","description":"Total time in seconds for event type \"streaming\""},"idle":{"type":"integer","description":"Total time in seconds for event type \"user_state\", sub type \"idle\""},"lock":{"type":"integer","description":"Total time in seconds for event type \"user_state\", sub type \"lock\""}}},"CyberSightReportUserTimelineEvents":{"type":"object","properties":{"active":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimelineEvent"}},"streaming":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimelineEvent"}},"idle":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimelineEvent"}},"lock":{"type":"array","items":{"$ref":"#/components/schemas/CyberSightReportUserTimelineEvent"}}},"description":"Events grouped by type. Each key is present only when at least one event of\nthat type exists in the requested time range. Consecutive events of the same\ntype are merged into a single span."},"CyberSightReportUserTimelineEvent":{"type":"object","properties":{"starts_at":{"type":"string","description":"format:iso8601 Start time of the event span"},"ends_at":{"type":"string","description":"format:iso8601 End time of the event span"}}},"CyberSightClientActivateSpec":{"type":"object","properties":{"user_agent_id":{"type":"string","format":"uuid","description":"User agent id"},"cyber_sight_client":{"$ref":"#/components/schemas/CyberSightClientActivate"}},"required":["user_agent_id"],"description":"User agent creation request parameters"},"CyberSightClientActivate":{"type":"object","properties":{"service_version":{"type":"string","description":"Cyber sight client version"},"chrome_extension_status":{"type":"string","enum":["not_installed","operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"],"description":"Device's chrome extension status"},"edge_extension_status":{"type":"string","enum":["not_installed","operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"],"description":"Device's edge extension status"},"upstream_communication_state":{"type":"string","enum":["operational","disabled","error"],"description":"Device's upstream communication status"},"url_filtering":{"type":"boolean","description":"Cyber sight client currently url filtering"},"ip_filtering":{"type":"boolean","description":"Cyber sight client currently ip filtering"},"privacy_mode":{"type":"string","enum":["none","standard"],"description":"Cyber sight client current privacy mode"}},"description":"User agent creation request parameters"},"CyberSightCsvExport":{"type":"object","properties":{"uuid":{"type":"string","description":"format:uuidv7 CyberSight CSV export UUID"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs included in the export"},"url":{"type":"string","description":"Presigned S3 URL to download the CSV file (null if export is still processing or failed)"},"error":{"type":"string","description":"Error message if export failed (null if export succeeded)"}},"description":"CyberSight CSV Export"},"CyberSightCsvExportCreate":{"type":"object","properties":{"cyber_sight_csv_export":{"type":"object","properties":{"included_columns":{"type":"array","items":{"type":"string"}},"organization_ids":{"type":"array","items":{"type":"integer"}}},"description":"Request body nest. included_columns: column keys to include (optional). organization_ids: deprecated, use top-level org_uuids instead; still accepted for backward compatibility."},"report_type":{"type":"string","enum":["activity_logs","top_websites","top_applications","top_categories","top_streaming","top_risky_users","top_active_clients","top_ai_usage"],"description":"Type of CyberSight Report to export"},"ai_tool":{"type":"string","enum":["all","web","app","client"],"description":"Required when report_type is top_ai_usage. Selects the AI activity view: \"web\" for AI websites, \"app\" for AI applications, \"all\" for a combined web+app row list, \"client\" for AI usage per roaming client. When ai_tool is \"web\" or \"all\", the export includes a \"categories\" column (\"Category\" header) listing comma-joined web category names per row; for \"all\", application rows render this column as \"-\"."},"start_at":{"type":"string","description":"format:iso8601 Start date/time for the report query"},"end_at":{"type":"string","description":"format:iso8601 End date/time for the report query"},"msp_uuid":{"type":"string","description":"format:uuidv7 MSP UUID to scope the export (preferred)"},"org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 Organization UUIDs to scope the export (preferred; use instead of cyber_sight_csv_export.organization_ids)"},"excluded_org_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 Organization UUIDs to exclude from results"},"category_ids":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"integer"}},{"type":"object","properties":{"operator":{"type":"string","enum":["is","isnot"]},"value":{"oneOf":[{"type":"array","items":{"type":"integer"}},{"type":"string"}]}}}],"description":"strings should be comma delimited integers"},"user_agent_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 User agent UUIDs to filter by"},"agent_local_user_uuids":{"type":"array","items":{"type":"string"},"description":"format:uuidv7 Agent local user UUIDs to filter by"},"weekdays_only":{"type":"boolean","description":"default:false Only include weekdays in results"},"search_id":{"type":"string","description":"OpenSearch async search ID for continuation"},"size":{"type":"integer","description":"Maximum number of results (e.g. buckets) to return"},"activity_type_ids":{"type":"array","items":{"type":"integer"},"description":"Activity type IDs to filter by (activity_logs only)"},"app_executable_path":{"type":"string","description":"Filter by application executable path, regex (activity_logs, top_applications, top_ai_usage when ai_tool=app)"},"app_name":{"type":"string","description":"Filter by application name, regex (activity_logs, top_applications, top_streaming, top_ai_usage when ai_tool=app)"},"app_window_title":{"type":"string","description":"Filter by application window title, regex (activity_logs, top_applications, top_ai_usage when ai_tool=app)"},"web_full_url":{"type":"string","description":"Filter by web full URL, regex (activity_logs, top_websites, top_ai_usage when ai_tool=web)"},"web_host":{"type":"string","description":"Filter by web host, regex (activity_logs, top_websites, top_ai_usage when ai_tool=web)"},"threats_only":{"type":"boolean","description":"Filter to threat categories only (top_categories only)"},"web_categories":{"type":"string","description":"Comma-separated category IDs (top_categories, top_categories_users; required for top_categories_users)"},"sort_by":{"type":"string","enum":["app_executable_path","app_name","app_window_title","cyber_sight_service_version","event_duration","event_end_at","event_start_at","remote_ip","web_full_url","web_host"],"description":"default is event_start_at (activity_logs only)"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"Sort direction for results"}},"required":["report_type","start_at","end_at"],"description":"CyberSight CSV Export creation request"},"CyberSightCsvExportPending":{"type":"object","properties":{"export":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"type":"string"}},"description":"Export information"},"export.uuid":{"type":"string","description":"format:uuidv7 CyberSight CSV export UUID"},"export.status":{"type":"string","description":"enum\u003cprocessing\u003e Status indicating the export is still processing"}},"description":"CyberSight CSV Export Pending Response"},"Dashboard":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"name":{"type":"string","description":"Name"},"data":{"type":"object","description":"JSON data structure"},"is_public":{"type":"boolean","description":"True if the dashboard is public"},"created_at":{"type":"string","format":"date","description":"Creation date-time"},"updated_at":{"type":"string","format":"date","description":"Updated date-time"},"user":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"description":"Optional owning user"}},"description":"Dashboard resource"},"DashboardCreate":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"data":{"type":"object","description":"JSON data structure"},"is_public":{"type":"boolean","description":"Is public and available to other users (default:false)"}},"required":["name","data"],"description":"Dashboard creation parameters"},"DashboardCreateSpec":{"type":"object","properties":{"dashboard":{"$ref":"#/components/schemas/DashboardCreate"}},"required":["dashboard"],"description":"Dashboard creation request parameters"},"DashboardUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"data":{"type":"object","description":"JSON data structure"},"is_public":{"type":"boolean","description":"Is public and available to other users (default:false)"}},"description":"Dashboard update parameters"},"DashboardUpdateSpec":{"type":"object","properties":{"dashboard":{"$ref":"#/components/schemas/DashboardUpdate"}},"required":["dashboard"],"description":"Dashboard update request parameters"},"Distributor":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"name":{"type":"string"},"support_email":{"type":"string"},"support_phone":{"type":"string"},"support_url":{"type":"string"},"support_description":{"type":"string"},"show_support_info":{"type":"boolean"},"parent_organization":{"$ref":"#/components/schemas/OrganizationDistributor"}},"description":"Distributor resource"},"OrganizationDistributor":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"name":{"type":"string","description":"Organization name"},"external_id":{"type":"string","description":"Organization ID on customer systems"},"status":{"type":"string","enum":["active","canceled","trial"]},"distributor_id":{"type":"string","description":"Organization ID on distributor systems.\nIt is lowercased on DNSFilter side.\nThis value should be unique across all distributor organizations if specified."},"distributor_status":{"type":"string","description":"Organization status on distributor systems.\nDNSFilter does nothing with this"},"distributor_skus":{"type":"array","items":{"type":"string"},"description":"Organization product SKUs"},"distributor_stated_user_count":{"type":"integer","description":"Stated user count (defult: 0)"},"distributor_nfr_user_count":{"type":"integer","description":"Not for resale (NFR) stated user count (default: 0)\nOnly valid for MSPs parent organizations, it will be always 0 for MSPs customers."},"distributor_stated_wifi_count":{"type":"integer"},"gdpr":{"type":"boolean","description":"GDPR enabled (default: false)"},"user_agents_auto_update":{"type":"boolean","description":"Roaming clients auto-update enabled (default: false)"},"sync_tools_auto_update":{"type":"boolean","description":"Active directory sync tools auto-update enabled (default: false)"},"summary_email_enabled":{"type":"boolean","description":"Weekly traffic summary email enabled (default: false)"},"managed_by_msp_id":{"type":"integer"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"},"canceled_at":{"type":"integer"},"transferred_at":{"type":"integer"}},"description":"OrganizationDistributor resource"},"MspDistributor":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"name":{"type":"string","description":"MSP name"},"total_roaming_clients":{"type":"integer","description":"Total Roaming Clients registered for the MSP"},"allow_site_creation":{"type":"boolean","description":"Allows MSP customers to create sites on their own. (default: true)"},"prevent_sub_org_creation":{"type":"boolean","description":"Prevents the MSP on creating customers, the MSP has to rely on the distributor to do that (default: false)"},"parent_organization":{"$ref":"#/components/schemas/OrganizationDistributor"}},"description":"MSP Distributor resource"},"UserDistributor":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"email":{"type":"string","description":"Email address.\nIt is lowercased on DNSFilter side."},"name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"distributor_guid":{"type":"string","description":"User ID on distributor systems.\nIt is lowercased on DNSFilter side.\nThis value should be unique across all distributor users if specified."},"created_at_epoch_utc":{"type":"integer"},"created_at":{"type":"integer"},"transferred_at":{"type":"integer"},"memberships":{"type":"array","items":{"$ref":"#/components/schemas/UserMembershipDistributor"}}},"description":"User Distributor resource"},"UserMembershipDistributor":{"type":"object","properties":{"role":{"type":"string","enum":["owner","super_administrator","administrator","read_only","technical","accountant","policies_only"],"description":"Note: An user could only be an owner of a single organization.\nNote: An organization can only have one owner user"},"organization_id":{"type":"integer","description":"Organization ID for which the membership is going to be tied to"},"is_include_only_list":{"type":"boolean","description":"Defines if the user is going to have access or restricted access to the organization list defined on the organization_permission_ids param:\ntrue: user ONLY has access to the organizations/sub-organizations defined\non the organization_permission_ids param.\nfalse: user has access to all MSP sub-organizations (or even the MSP parent\norganization) EXCEPT to the ones defined on the organization_permission_ids\nparam.\nOnly valid if organization_id is an MSP parent organization, it will be always false otherwise"},"organization_permission_ids":{"type":"array","items":{"type":"integer"},"description":"List of organization/sub-organization IDs the user is going to have access/restricted access\nOnly valid if organization_id is an MSP parent organization, it will be always empty otherwise"}},"description":"User Membership Distributor resource"},"DistributorUpdate":{"type":"object","properties":{"support_email":{"type":"string"},"support_phone":{"type":"string"},"support_url":{"type":"string"},"support_description":{"type":"string"},"show_support_info":{"type":"boolean"}},"description":"Distributor update request parameters"},"DistributorUpdateSpec":{"type":"object","properties":{"distributor":{"$ref":"#/components/schemas/DistributorUpdate"}},"required":["distributor"]},"MspDistributorCreateSpec":{"type":"object","properties":{"msp":{"$ref":"#/components/schemas/MspDistributor"}},"required":["msp"]},"MspDistributorUpdateSpec":{"type":"object","properties":{"msp":{"$ref":"#/components/schemas/MspDistributor"}},"required":["msp"]},"OrganizationDistributorCreateSpec":{"type":"object","properties":{"msp":{"$ref":"#/components/schemas/OrganizationDistributor"}},"required":["msp"]},"OrganizationDistributorUpdateSpec":{"type":"object","properties":{"msp":{"$ref":"#/components/schemas/OrganizationDistributor"}},"required":["msp"]},"UserMembershipDistributorSpec":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/UserMembershipDistributor"}},"required":["membership"]},"UserDistributorCreateSpec":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserDistributor"},"membership":{"$ref":"#/components/schemas/Membership"},"send_reset_password_email":{"type":"boolean"},"return-reset_password_url":{"type":"boolean"}},"required":["user","membership"]},"Domain":{"type":"object","properties":{"host":{"type":"string","description":"Host"},"name":{"type":"string","description":"Name"}},"description":"Domain resource"},"DomainSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"$ref":"#/components/schemas/ApplicationLookup"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Domain"},"relationships":{"type":"object","properties":{"categories":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Domain current associated categories and applications"}}}],"description":"Domain specification"},"DomainCreate":{"type":"object","properties":{"name":{"type":"string","description":"FQDN"},"host":{"type":"string","description":"Domain host"}},"required":["name","host"],"description":"Domain creation request parameters"},"DomainCreateSpec":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/DomainCreate"}},"required":["domain"],"description":"Domain creation request parameters"},"DomainNotesCreateSpec":{"type":"object","properties":{"type":{"type":"string","enum":["allow","block"],"description":"Type of notes (allow, block), defaults to allow"},"domain":{"type":"string","description":"Allow/block list domain"},"note":{"type":"string","description":"Notes for domain"}},"required":["type","domain"],"description":"Ressource Notes creation request parameters"},"DomainNotesSpec":{"type":"object","properties":{"allow_notes":{"type":"object","description":"Notes for allowed domains"},"block_notes":{"type":"object","description":"Notes for blocked domains"}},"description":"Domain notes response"},"EnterpriseConnection":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"organization_id":{"type":"integer","description":"Organization ID"},"default_organization_id":{"type":"integer","description":"Default organization ID"},"name":{"type":"string","description":"Name"},"display_name":{"type":"string","description":"Display Name"},"role_default":{"type":"integer","description":"Default role"},"role_map":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseConnectionRoleMap"},"description":"Role map"},"sub_prefix":{"type":"string"},"conn_id":{"type":"string"},"idp":{"type":"string","enum":["openid","okta","azure","google"],"description":"The type of the enterprise connection's IDP."},"authorized_domains":{"type":"array","items":{"type":"string"},"description":"Domains that are authorized to connect."}}},"EnterpriseConnectionCreatePayload":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"default_organization_id":{"type":"integer","description":"Default organization ID"},"strategy":{"type":"string","enum":["oidc"]},"display_name":{"type":"string","description":"The, UI visible, name of the connection. If blank will default to strategy."},"role_default":{"type":"string","enum":["administrator","read_only","owner","technical","accountant","policies_only","super_administrator"],"description":"The default role. If blank, defaults to read_only."},"role_map":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseConnectionRoleMap"}},"options":{"$ref":"#/components/schemas/EnterpriseConnectionOptions"},"idp":{"type":"string","enum":["openid","okta","azure","google"],"description":"The type of the enterprise connection's IDP."},"authorized_domains":{"type":"array","items":{"type":"string"},"description":"Domains that are authorized to connect."}},"required":["organization_id","strategy","options"],"description":"Note: To set your organization's custom login url for enterprise\nconnections, you need to set the 'unique_id' attribute on the\norganization itself. See the PATCH /v1/organizations endpoint."},"EnterpriseConnectionUpdatePayload":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"default_organization_id":{"type":"integer","description":"Default organization ID"},"display_name":{"type":"string","description":"The, UI visible, name of the connection."},"role_default":{"type":"string","enum":["administrator","read_only","owner","technical","accountant","policies_only","super_administrator"],"description":"The default role."},"role_map":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseConnectionRoleMap"}},"options":{"$ref":"#/components/schemas/EnterpriseConnectionOptions"},"idp":{"type":"string","enum":["openid","okta","azure","google"],"description":"The type of the enterprise connection's IDP."},"authorized_domains":{"type":"array","items":{"type":"string"},"description":"Domains that are authorized to connect."}},"required":["options"],"description":"Note: To set your organization's custom login url for enterprise\nconnections, you need to set the 'unique_id' attribute on the\norganization itself. See the PATCH /v1/organizations endpoint."},"EnterpriseConnectionOptions":{"type":"object","properties":{"client_id":{"type":"string","description":"Used by: oidc"},"client_secret":{"type":"string","description":"Used by: oidc"},"discovery_url":{"type":"string","description":"Used by: oidc"}},"description":"The options are dependent upon the strategy for the enterprise connection\nitself. Check the descriptions for each attribute to determine if it is\nnecessary."},"EnterpriseConnectionRoleMap":{"type":"object","properties":{"role":{"type":"string"},"group":{"type":"string"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message (e.x.: Not Authorized)"}},"description":"Error basic representation"},"ErrorBoolMessage":{"type":"object","properties":{"error":{"type":"boolean","description":"Error occurred yes/no"},"message":{"type":"string","description":"Error description"}},"description":"Error basic representation"},"ErrorAndTypeMessage":{"type":"object","properties":{"error":{"type":"string","description":"Error message (e.x.: Not Authorized)"},"type":{"type":"string","description":"Error type (e.x.: validation)"}},"description":"Error basic representation"},"ErrorSubscriptionBeneficiariesBatchMessage":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Error messages"},"type":{"type":"string","description":"Type of error messages"}},"description":"Error basic representation"},"FilteringClientActivateSpec":{"type":"object","properties":{"user_agent_id":{"type":"string","format":"uuid","description":"User agent id"},"filtering_client":{"$ref":"#/components/schemas/FilteringClientActivate"}},"required":["user_agent_id"],"description":"Filtering client creation request parameters"},"FilteringClientActivate":{"type":"object","properties":{"version":{"type":"string","description":"Filtering client current version"},"current_connection_method":{"type":"string","enum":["transparent_proxy","loopback"],"description":"Filtering client current connection method"},"current_filtering_method":{"type":"string","enum":["precheck","dns_filtering"],"description":"Filtering client current filtering method"},"current_fail_over_method":{"type":"string","enum":["fail_open","fail_close"],"description":"Filtering client current fail over method"}},"description":"Filtering client creation request parameters"},"IdentityConnection":{"type":"object","properties":{"id":{"type":"integer","description":"Identity Connection ID."},"name":{"type":"string","description":"Identity connection name."},"connection_type":{"type":"string","enum":["entra"],"description":"Identity connection type."},"description":{"type":"string","description":"Description (maybe null)."},"tenant_id":{"type":"string","description":"External tenant identifier."},"domain":{"type":"string","description":"Domain used by this identity connection (maybe null)."},"organization_id":{"type":"integer","description":"Organization ID (maybe null)."},"created_at":{"type":"string","format":"date","description":"creation date timestamp."},"updated_at":{"type":"string","format":"date","description":"last updated timestamp."},"collections_count":{"type":"integer","description":"Count of Collections that use this identity connection."},"connection_status":{"type":"object","properties":{"status":{"type":"string","enum":["connecting","syncing","error"]},"last_successful_at":{"type":"string","format":"date"},"last_error_at":{"type":"string","format":"date"},"last_error_message":{"type":"string"}},"description":"Current connection status."}},"description":"Identity Connection Resource Specification"},"IdentityConnectionsMetaSpec":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of identity connections."},"total_pages":{"type":"integer","description":"Total number of pages."},"current_page":{"type":"integer","description":"Current page number."}},"description":"Pagination metadata for Identity Connections List"},"IdentityConnectionCreateSpec":{"type":"object","properties":{"name":{"type":"string","description":"Identity connection name."},"connection_type":{"type":"string","enum":["entra"],"description":"Identity connection type."},"description":{"type":"string","description":"Description."},"tenant_id":{"type":"string","description":"Tenant ID for Entra ID Directory."},"domain":{"type":"string","description":"Domain used by this Tenant in Entra ID."},"organization_id":{"type":"integer","description":"Organization ID."}},"required":["name","connection_type","tenant_id"],"description":"Identity Connection creation payload."},"IdentityConnectionUpdateSpec":{"type":"object","properties":{"name":{"type":"string","description":"Identity connection name."},"description":{"type":"string","description":"Description."},"domain":{"type":"string","description":"Domain used by this identity connection."}},"description":"Identity Connection update request parameters"},"IdentityConnectionBulkDeleteSpec":{"type":"object","properties":{"ids":{"type":"string","description":"Comma delimited Identity Connection IDs"},"organization_id":{"type":"integer","description":"Organization ID to scope deletions. Required for all requests"}},"required":["ids","organization_id"],"description":"Identity Connection bulk delete request parameters"},"IdentityConnectionGetAuthTokenSpec":{"type":"object","properties":{"token_type":{"type":"string","description":"The type of token"},"expires_at":{"type":"integer","description":"The token expiration date in Unix timestamp form"},"access_token":{"type":"string","description":"The access token"}},"description":"Identity Connection token response payload"},"IdentityConnectionProvisionedMemberCountSpec":{"type":"object","properties":{"user_count":{"type":"integer","description":"The total number of provisioned users associated with this connection."},"group_count":{"type":"integer","description":"The total number of provisioned groups associated with this connection."}},"description":"Identity Connection provisioned member count payload"},"IgnoreDomainSpec":{"type":"object","properties":{"value":{"type":"string","description":"Value"}},"description":"Ignore domain resource"},"IgnoreDomainCreateDomain":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"}},"description":"Ignore domain resource"},"IgnoreDomainCreate":{"type":"object","properties":{"policy_id":{"type":"integer","description":"Policy id that ignore domains may belong to"},"organization_id":{"type":"integer","description":"Organization id that ignore domains maybe belong to"},"ignore_domains":{"type":"array","items":{"$ref":"#/components/schemas/IgnoreDomainCreateDomain"},"description":"A list of domains to create"}},"description":"Ignore domain resource"},"IgnoreDomainUpdateDomain":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"}},"description":"Ignore domain resources"},"IgnoreDomainUpdate":{"type":"object","properties":{"policy_id":{"type":"integer","description":"Policy id that ignore domains may belong to (if policy level ignore domain)"},"organization_id":{"type":"integer","description":"Organization id that ignore domains may belong to (required)"},"ignore_domain":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IgnoreDomainUpdateDomain"},"description":"Changes to domain"}},"description":"Ignore domain resources"},"IgnoreDomainDestroy":{"type":"object","properties":{"policy_id":{"type":"integer","description":"Policy id that the ignore domain may belongs to (if policy level ignore domain)"},"organization_id":{"type":"integer","description":"Organization id that ignore domain belongs to (required)"}},"description":"Ignore domain resource"},"InternalBlockedEmail":{"type":"object","properties":{"network_id":{"type":"integer","description":"Network ID"},"client_id":{"type":"string","description":"User Agent ID"},"email":{"type":"string","description":"user email"},"name":{"type":"string","description":"user name"},"phone":{"type":"string","description":"user phone"},"message":{"type":"string","description":"message"},"user_agent":{"type":"string","description":"User Agent info"},"ip_address":{"type":"string","description":"IP address"},"blocked_domain":{"type":"string","description":"Blocked domain"},"local_time":{"type":"string","description":"Local time"},"policy_name":{"type":"string","description":"Policy name"},"category_name":{"type":"string","description":"Category name"}},"required":["network_id"],"description":"Blocked email request parameters"},"Invoice":{"type":"object","properties":{"id":{"type":"integer","description":"Invoice ID"},"start_date":{"type":"string","format":"date","description":"Billing start date"},"end_date":{"type":"string","format":"date","description":"Billing end date"},"organization_id":{"type":"integer","description":"Organization resource ID"},"created_at":{"type":"string","format":"date","description":"Invoice creation date"},"updated_at":{"type":"string","format":"date","description":"Invoice last update date"},"total_cents":{"type":"integer","description":"Total invoice amount (cents)"},"stripe_id":{"type":"string","description":"Invoice Stripe ID"},"requests":{"type":"integer","description":"Total number of DNS requests"},"paid":{"type":"boolean","description":"Invoice has been paid (may be null)"},"closed":{"type":"boolean","description":"Invoice has been closed (may be null)"},"forgiven":{"type":"boolean","description":"Invoice has been forgiven (may be null)"},"payment_attempts":{"type":"integer","description":"Total number of payment attempts (may be null)"},"payment_first_attempt":{"type":"string","format":"date","description":"First payment attempt (may be null)"},"payment_last_attempt":{"type":"string","format":"date","description":"Last payment attempt (may be null)"},"payment_date":{"type":"string","format":"date","description":"Payment date (may be null)"},"payment_receipt_number":{"type":"string","description":"Receipt number (may be null)"},"organization_name":{"type":"string","description":"Organization name"},"invoice_item_groups":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemGroup"},"description":"Invoice item groups"},"invoice_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"},"description":"Invoice items"}},"description":"Invoice resource"},"InvoiceItem":{"type":"object","properties":{"id":{"type":"integer","description":"Invoice item ID"},"invoice_id":{"type":"integer","description":"Invoice ID"},"network_name":{"type":"string","description":"Network name"},"network_id":{"type":"integer","description":"Network ID"},"cents":{"type":"integer","description":"Total amount (cents) for item"},"requests":{"type":"integer","description":"Total number of DNS requests for item"},"created_at":{"type":"string","format":"date","description":"Item creation date"},"updated_at":{"type":"string","format":"date","description":"Item last update date"},"stripe_id":{"type":"string","description":"Invoice Stripe ID"},"discounted":{"type":"boolean","description":"Item discounted"},"invoice_item_group_id":{"type":"integer","description":"Invoice item group ID"}},"description":"Invoice item resource"},"InvoiceItemGroup":{"type":"object","properties":{"id":{"type":"integer","description":"Invoice item group ID"},"invoice_id":{"type":"integer","description":"Invoice ID"},"organization_name":{"type":"string","description":"Organization name"},"organization_id":{"type":"integer","description":"Organization resource ID"},"subtotal_cents":{"type":"integer","description":"Total amount (cents) for item group"},"created_at":{"type":"string","format":"date","description":"Item group creation date"},"updated_at":{"type":"string","format":"date","description":"Item group last update date"},"invoice_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"},"description":"Item group associated items"}},"description":"Invoice item group resource"},"IpAddress":{"type":"object","properties":{"ip":{"type":"string","description":"IP"},"address":{"type":"string","description":"IP address"},"network_id":{"type":"integer","description":"Network ID"},"organization_id":{"type":"integer","description":"Organization ID"}},"description":"IpAddress resource"},"IpAddressDetail":{"type":"object","properties":{"addr":{"type":"integer","description":"IP address"},"family":{"type":"integer","description":"IP address family"},"mask_addr":{"type":"integer","description":"IP address mask address"}},"description":"IpAddressDetail resource"},"IpAddressHistory":{"type":"object","properties":{"created_at":{"type":"string","format":"date","description":"Event creation date"},"event":{"type":"string","description":"Event type (create, update, delete, etc.)"},"object_changes":{"$ref":"#/components/schemas/IpAddressHistoryAttributes"}},"description":"IpAddress history resource"},"IpAddressHistoryAttributes":{"type":"object","properties":{"id":{"type":"array","items":{"type":"integer"},"description":"Two size array, with old and new value (can be `null`)"},"ip":{"type":"array","items":{"$ref":"#/components/schemas/IpAddressDetail"},"description":"Two size array, with old and new value (can be `null`)"},"address":{"type":"array","items":{"type":"string"},"description":"Two size array, with old and new value (can be `null`)"},"created_at":{"type":"array","items":{"type":"string","format":"date"},"description":"Two size array, with old and new value (can be `null`)"},"network_id":{"type":"array","items":{"type":"integer"},"description":"Two size array, with old and new value (can be `null`)"},"updated_at":{"type":"array","items":{"type":"string","format":"date"},"description":"Two size array, with old and new value (can be `null`)"},"organization_id":{"type":"array","items":{"type":"integer"},"description":"Two size array, with old and new value (can be `null`)"}},"description":"IpAddress history attributes"},"IpAddressHistorySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/IpAddressHistory"},"relationships":{"type":"object","properties":{"user":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"association_versions":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"IP address associated history"}}}],"description":"Ip Address history specification"},"IpAddressSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/IpAddress"},"relationships":{"type":"object","properties":{"network":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"IP address associated network"}}}],"description":"IpAddress specification"},"IpAddressCreate":{"type":"object","properties":{"address":{"type":"string","description":"IP address"},"organization_id":{"type":"integer","description":"Organization ID that the IP address belongs to"},"network_id":{"type":"integer","description":"Network ID that the IP address belongs to"},"dynamic_hostname":{"type":"string","description":"Dynamic hostname of the IP address"}},"required":["address","organization_id","network_id"],"description":"IP address creation request parameters"},"IpAddressCreateSpec":{"type":"object","properties":{"ip_address":{"$ref":"#/components/schemas/IpAddressCreate"}},"required":["ip_address"],"description":"IP address creation request parameters"},"LicensePlanOverageStatus":{"type":"object","properties":{"license_status":{"type":"string","description":"License status (normal, warning, critical)"},"suppress_warning":{"type":"boolean","description":"Indicates if the a warning status should be suppressed in the UI"}},"description":"License Plan Overage Status"},"LicensePool":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of license"},"plan_name":{"type":"string","description":"Plan name"},"total":{"type":"integer","description":"Total number of licenses available"},"used":{"type":"integer","description":"Number of licenses used"},"available":{"type":"integer","description":"Number of licenses available"}},"description":"LicensePool resource"},"LicensePoolSpec":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensePool"},"description":"List of licenses"},"meta":{"type":"object","description":"Relevant metadata"}},"description":"License Pool Specification"},"LicenseUsageDataPoint":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO8601 format"},"roaming_clients":{"type":"integer","description":"Number of roaming client licenses"},"network_traffic":{"type":"integer","description":"Number of network traffic licenses"},"granularity":{"type":"string","description":"Data granularity (\"month_to_date\", \"partial_month\", \"month\" or \"day\")"}},"description":"Usage data point for a specific date"},"LicenseUsageHistoryMeta":{"type":"object","properties":{"date_range":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"description":"Date range of the data in ISO8601 format"},"total_count":{"type":"integer","description":"Total number of usage data points"}},"description":"Usage history metadata"},"LicenseUsageHistorySpec":{"type":"object","properties":{"usage":{"type":"array","items":{"$ref":"#/components/schemas/LicenseUsageDataPoint"},"description":"List of usage data points"},"meta":{"$ref":"#/components/schemas/LicenseUsageHistoryMeta"}},"description":"Usage history specification"},"MacAddress":{"type":"object","properties":{"address":{"type":"string","description":"MAC address (may be null)"},"filter_value":{"type":"string","description":"Value used to filter queries"},"created_at":{"type":"string","format":"date","description":"Creation date"},"updated_at":{"type":"string","format":"date","description":"Last update"}},"description":"MAC address resource"},"MacAddressSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/MacAddress"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"scheduled_policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"block_page":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"MAC address associated objects"}}}],"description":"MAC address specification"},"MacAddressCreate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"address":{"type":"string","description":"MAC address with colons *aa:bb:cc:dd:ee:ff*"},"filter_value":{"type":"string","description":"Obfuscated MAC address value, defaults to MAC address without colons"},"policy_id":{"type":"integer","description":"MAC address custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set"},"scheduled_policy_id":{"type":"integer","description":"MAC address custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"MAC address custom block page ID"}},"required":["organization_id"],"description":"MAC address creation request parameters"},"MacAddressCreateSpec":{"type":"object","properties":{"mac_address":{"$ref":"#/components/schemas/MacAddressCreate"}},"required":["mac_address"],"description":"MAC address creation request parameters"},"Membership":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization resource ID"},"user_id":{"type":"integer","description":"User resource ID"},"role":{"type":"string","enum":["administrator","read_only","network_administrator","network_support","support"],"description":"Role"}},"description":"Membership resource"},"Msp":{"type":"object","properties":{"name":{"type":"string","description":"MSP name"},"custom_domain":{"type":"string","description":"Custom APP domain (may be null)"},"custom_logo":{"type":"string","description":"Custom APP logo (may be null)"},"owner_organization_id":{"type":"integer","description":"Parent organization"},"plan":{"type":"string","description":"Signup plan"},"actual_plan":{"type":"string","description":"Plan according to usage"},"whitelabel_enabled":{"type":"boolean","description":"Whitelabel enabled/disabled"},"allow_site_creation":{"type":"boolean","description":"Allows site creation to customers"},"email_template":{"type":"string","description":"Email template name"}},"description":"MSP resource"},"MspSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Msp"}}}],"description":"MSP specification"},"SubOrgDistributorSku":{"type":"object","properties":{"sku":{"type":"string","description":"SKU value"},"enabled":{"type":"boolean","description":"Enable or disable SKU"}},"required":["sku","enabled"],"description":"SKUs to enable or disable in the update request"},"SubOrgDistributorPropertiesUpdateSpec":{"type":"object","properties":{"id":{"type":"integer","description":"ID of sub-organization"},"user_count":{"type":"integer","description":"Distributor Stated User Count"},"wifi_count":{"type":"integer","description":"Distributor Stated WiFi Count"},"distributor_skus":{"type":"array","items":{"$ref":"#/components/schemas/SubOrgDistributorSku"},"description":"SKUs to be enabled or disabled"}},"required":["id"],"description":"Update MSP sub-organizations distributor fields"},"ArrayIntegerIsOp":{"type":"object","properties":{"operator":{"type":"string","enum":["is","isnot"]},"value":{"oneOf":[{"type":"array","items":{"type":"integer"}},{"type":"string"}]}}},"StringMatchOp":{"type":"object","properties":{"operator":{"type":"string","enum":["equals","doesnotequal","contains","doesnotcontain","startswith","endswith"]},"value":{"type":"string"}}},"StringContainsOp":{"type":"object","properties":{"operator":{"type":"string","enum":["contains","doesnotcontain"]},"value":{"type":"string"}}},"NetworkLanIp":{"type":"object","properties":{"version":{"type":"integer","description":"LAN IP family version"},"address":{"type":"string","description":"LAN IP address"},"name":{"type":"string","description":"LAN IP name or alias (may be null)"},"first_seen":{"type":"string","format":"date","description":"First traffic seen from this address (may be null)"},"last_seen":{"type":"string","format":"date","description":"Last traffic seen from this address (may be null)"}},"description":"User agent resource"},"NetworkLanIpSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/NetworkLanIp"},"relationships":{"type":"object","properties":{"network":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"LAN IP associated objects"}}}],"description":"User agent specification"},"NetworkLanIpUpdate":{"type":"object","properties":{"name":{"type":"string","description":"LAN IP name or alias"}},"description":"Network creation request parameters"},"NetworkLanIpUpdateSpec":{"type":"object","properties":{"network_lan_ip":{"$ref":"#/components/schemas/NetworkLanIpUpdate"}},"required":["network_lan_ip"],"description":"Network subnet creation request parameters"},"NetworkSubnet":{"type":"object","properties":{"version":{"type":"integer","description":"Subnet IP family version"},"name":{"type":"string","description":"Subnet name or alias"},"from":{"type":"string","description":"Subnet lower private IP address"},"to":{"type":"string","description":"Subnet upper private IP address"}},"description":"User agent resource"},"NetworkSubnetSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/NetworkSubnet"},"relationships":{"type":"object","properties":{"network":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"scheduled_policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"] Subnet associated objects"}}}],"description":"User agent specification"},"NetworkSubnetCreate":{"type":"object","properties":{"name":{"type":"string","description":"Subnet name or alias"},"from":{"type":"string","description":"Subnet lower private IP address"},"to":{"type":"string","description":"Subnet upper private IP address"},"policy_id":{"type":"integer","description":"Subnet custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set"},"scheduled_policy_id":{"type":"integer","description":"Subnet custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"Subnet custom block page ID"}},"required":["name","from","to"],"description":"Network creation request parameters"},"NetworkSubnetCreateSpec":{"type":"object","properties":{"network_subnet":{"$ref":"#/components/schemas/NetworkSubnetCreate"}},"required":["network_subnet"],"description":"Network subnet creation request parameters"},"Network":{"type":"object","properties":{"name":{"type":"string","description":"Network name"},"physical_address":{"type":"string","description":"Network physical address (may be null)"},"latitude":{"type":"number","format":"double","description":"Network reported latitude"},"longitude":{"type":"number","format":"double","description":"Network reported longitude"},"block_default_appearance":{"type":"boolean","description":"Default page appearance for blocked pages"},"block_org_name":{"type":"string","description":"Blocked page organization name (may be null)"},"block_email_addr":{"type":"string","description":"Blocked page email address (may be null)"},"block_logo_uuid":{"type":"string","description":"Blocked page custom logo (may be null)"},"allow_all_policies":{"type":"boolean","description":"Allow all policies"},"billing_per_user":{"type":"boolean","description":"Network usage billing per user"},"billing_user_count":{"type":"integer","description":"User network usage count"},"network_type_units":{"type":"integer","description":"User network usage count"},"block_page_id":{"type":"integer","description":"Block page ID"},"scheduled_policy_id":{"type":"integer","description":"Scheduled policy ID"},"secret_key":{"type":"string","description":"Network secret key for user agents and LAN proxies"},"deleted_at":{"type":"string","format":"date","description":"Item deletion date (may be null)"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"local_domains":{"type":"array","items":{"type":"string"},"description":"Array of local domains or DNS suffixes that should bypass filtering"},"local_resolvers":{"type":"array","items":{"type":"string"},"description":"Array of IP addresses of local DNS serviers that handle local domains"}},"description":"Network resource"},"NetworkSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Network"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"ip_addresses":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}},"policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"scheduled_policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"block_page":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"policies":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Network associated resources"}}}],"description":"Network specification"},"NetworkCreate":{"type":"object","properties":{"name":{"type":"string","description":"Network name"},"organization_id":{"type":"integer","description":"Organization resource ID"},"block_page_id":{"type":"integer","description":"Network custom block page ID"},"policy_ids":{"type":"array","items":{"type":"integer"},"description":"Network policy IDs"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"is_legacy_vpn_active":{"type":"boolean","description":"Is Legacy VPN Active"},"physical_address":{"type":"string","description":"Network physical address"},"ip_addresses_attributes":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"key":{"type":"string","format":"uuid"}}},"description":"IP Address to add"},"local_domains":{"type":"array","items":{"type":"string"},"description":"Array of local domains or DNS suffixes that should bypass filtering"},"local_resolvers":{"type":"array","items":{"type":"string"},"description":"Array of IP addresses of local DNS serviers that handle local domains"}},"required":["name","organization_id"],"description":"Network creation request parameters"},"NetworkCreateSpec":{"type":"object","properties":{"network":{"$ref":"#/components/schemas/NetworkCreate"}},"required":["network"],"description":"Network creation request parameters"},"NetworkUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Network name"},"organization_id":{"type":"integer","description":"Organization resource ID"},"block_page_id":{"type":"integer","description":"Network custom block page ID"},"policy_ids":{"type":"array","items":{"type":"integer"},"description":"Network policy IDs"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"is_legacy_vpn_active":{"type":"boolean","description":"Is Legacy VPN Active"},"physical_address":{"type":"string","description":"Network physical address"},"ip_addresses_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"address":{"type":"string"},"key":{"type":"string","format":"uuid"}}},"description":"IP Address to add/update"},"local_domains":{"type":"array","items":{"type":"string"},"description":"Array of local domains or DNS suffixes that should bypass filtering"},"local_resolvers":{"type":"array","items":{"type":"string"},"description":"Array of IP addresses of local DNS serviers that handle local domains"}},"required":["name","organization_id"],"description":"Network update request parameters"},"NetworkBulkUpdateSpec":{"type":"object","properties":{"ids":{"type":"string","description":"Comma delimited Network IDs or keyword 'all'"},"organization_id":{"type":"integer","description":"Organization ID. Required if ids is 'all'"},"policy_id":{"type":"integer","description":"Policy ID"},"scheduled_policy_id":{"type":"integer","description":"Scheduled Policy ID"},"block_page_id":{"type":"integer","description":"Block Page ID"},"is_legacy_vpn_active":{"type":"boolean","description":"Is Legacy VPN Active"}},"required":["ids"],"description":"Network bulk update request parameters"},"NetworkBulkDestroySpec":{"type":"object","properties":{"ids":{"type":"string","description":"Comma delimited Network IDs or keyword 'all'"},"organization_id":{"type":"integer","description":"Organization ID. Required if ids is 'all'"}},"required":["ids"],"description":"Network bulk destroy request parameters"},"NetworkUpdateSpec":{"type":"object","properties":{"network":{"$ref":"#/components/schemas/NetworkUpdate"}},"required":["network"],"description":"Network update request parameters"},"NetworkLookup":{"type":"object","properties":{"block_org_name":{"type":"string","description":"Blocked page organization name (may be null)"},"block_email_addr":{"type":"string","description":"Blocked page email address (may be null)"},"block_logo_uuid":{"type":"string","description":"Blocked page custom logo (may be null)"},"block_default_appearance":{"type":"boolean","description":"Default page appearance for blocked pages"}},"description":"Network lookup response"},"NetworkGeo":{"type":"object","properties":{"id":{"type":"integer","description":"Network ID"},"organization_id":{"type":"integer","description":"Organization ID"},"name":{"type":"string","description":"Network name"},"latitude":{"type":"number","format":"double","description":"Network reported latitude"},"longitude":{"type":"number","format":"double","description":"Network reported longitude"},"physical_address":{"type":"string","description":"Network physical address (may be null)"}},"description":"NetworkGeo resource"},"NetworkCounts":{"type":"object","properties":{"all":{"type":"integer"},"offline":{"type":"integer"},"protected":{"type":"object","properties":{"count":{"type":"integer"},"network_ids":{"type":"array","items":{"type":"integer"}}}},"unprotected":{"type":"object","properties":{"count":{"type":"integer"},"network_ids":{"type":"array","items":{"type":"integer"}}}}}},"NetworksCsvExport":{"type":"object","properties":{"id":{"type":"integer","description":"Networks csv export ID"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs"},"url":{"type":"string","description":"URL to download the CSV"},"error":{"type":"string","description":"Error message if export failed"}},"description":"Networks csv export"},"NetworksCsvExportCreate":{"type":"object","properties":{"networks_csv_export":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"}},"msp_id":{"type":"integer"},"ids":{"type":"array","items":{"type":"integer"}}},"description":"CSV export attributes"}},"description":"Networks csv export"},"OrganizationServiceSettingBulkUpdate":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Set organizations scope"},"msp_id":{"type":"integer","description":"Set organizations scope"},"diagnostics_level":{"type":"string","enum":["trace","debug","information","warning","error","critical"],"description":"Configures diagnostics setting"},"connection_method":{"type":"string","enum":["transparent_prox","loopback"],"description":"Configures connection type"},"filtering_method":{"type":"string","enum":["precheck","dns_filtering"],"description":"Configures filtering mode"},"fail_over_method":{"type":"string","enum":["fail_open","fail_close"],"description":"Configures fail over method"},"enable_cybersight":{"type":"boolean","description":"Allows cybersight for organization"},"enable_browser_extension":{"type":"boolean","description":"Enables cybersight browser extensions"},"url_filtering":{"type":"boolean","description":"Enables cybersight url filtering"},"ip_filtering":{"type":"boolean","description":"Enables cybersight ip filtering"},"privacy_mode":{"type":"string","enum":["default","standard","identify_devices","maximum"],"description":"Configures privacy setting"},"pii_grid_search":{"type":"string","description":"Filter by organization name or privacy mode for pii grid search"},"exclude_inherit_privacy_mode":{"type":"boolean","description":"Exclude organizations that have inherit privacy mode"}},"description":"Organization service settings bulk update parameters"},"Organization":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"address":{"type":"string","description":"Organization legal address"},"allow_create_network":{"type":"boolean","description":"Current user can create new networks in the organization"},"allowlist_updated_at":{"type":"string","format":"date-time","description":"The datetime the allow list was last updated"},"billing_address":{"type":"string","description":"The organization's billing address"},"billing_contact_email":{"type":"string","description":"Contact email"},"billing_contact_name":{"type":"string","description":"Contact name"},"billing_contact_phone":{"type":"string","description":"Contact phone"},"billing_manual":{"type":"boolean","description":"Internal Use Only"},"blocklist_updated_at":{"type":"string","format":"date-time","description":"The datetime the block list was last updated"},"canceled":{"type":"boolean","description":"True if the organization has been canceled"},"canceled_at":{"type":"string","format":"date-time","description":"The datetime the organization was canceled"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"feature_flags":{"type":"array","items":{"type":"string"},"description":"Allowed features in APP"},"fetched_onboard_details":{"type":"boolean","description":"True if organization has provided onboarding details"},"first_traffic_sent":{"type":"string","format":"date-time","description":"The datetime the organizations first received DNS network traffic"},"industry":{"type":"string","description":"Internal Use Only"},"managed_by_msp_id":{"type":"integer","description":"Organization is managed by the specified MSP (may be null)"},"metadata":{"type":"string","description":"Internal Use Only"},"msp_feature_flags":{"type":"array","items":{"type":"string"},"description":"Allowed features in APP (defined for sub orgs only)"},"name":{"type":"string","description":"Organization legal name"},"owned_msp_id":{"type":"integer","description":"Organization is owned by an MSP (may be null)"},"plan_details":{"type":"string","description":"Internal Use Only"},"release_channel":{"type":"string","description":"Internal Use Only"},"role":{"type":"string","description":"Role"},"send_uninstall_notifications_to_admin_users":{"type":"boolean","description":"Notify admins of uninstall notifications"},"sso_enabled":{"type":"boolean","description":"Organization's SSO status"},"stripe_customer_id":{"type":"string","description":"Stripe ID"},"summary_email_address":{"type":"string","description":"The email to send the weekly summary of activity email"},"summary_email_enabled":{"type":"boolean","description":"True if the weekly summary of activity email should be sent"},"sync_tools_auto_update":{"type":"string","description":"Internal Use Only"},"trial_days":{"type":"integer","description":"Number of trial days (may be null)"},"unbounce_data":{"type":"string","description":"Internal Use Only"},"unique_id":{"type":"string","description":"A globally unique value among all organizations"},"update_payment":{"type":"boolean","description":"Organization has a valid payment method associated"},"usage_alert_cents":{"type":"string","description":"Internal Use Only"},"user_agent_uninstall_notification":{"type":"boolean","description":"Notify recipients when user agent is uninstalled"},"user_agent_uninstall_notification_recipient_emails":{"type":"array","items":{"type":"string"},"description":"Recipients to receive uninstalled user agent notifications"},"user_agents_auto_update":{"type":"boolean","description":"True if user agents will auto update"},"will_cancel_at":{"type":"string","format":"date-time","description":"The datetime the organization will be canceled"},"active_psa_integration":{"type":"boolean","description":"Organization has an active PSA integration"},"segment":{"type":"string","description":"Internal Use Only"},"vpn_settings_organization":{"type":"object","properties":{"vpn_settings_state_type_id":{"type":"integer"}},"description":"Vpn organization settings"}},"description":"Organization resource"},"OrganizationSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Organization"},"relationships":{"type":"object","properties":{"networks":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Network associated resources"}}}],"description":"Organization specification"},"OrganizationUser":{"type":"object","properties":{"id":{"type":"integer","description":"Email address"},"email":{"type":"string","description":"Email address"},"auth0_sub":{"type":"string","description":"The Auth0 ID of the user"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"phone":{"type":"string","description":"Phone number"},"email_verified":{"type":"boolean","description":"True if the email has been verified. Null if the status is unknown. This value is readonly. (may be null)"},"role":{"type":"string","description":"One of \"administrator\", \"read_only\""},"organization_permission_ids":{"type":"array","items":{"type":"integer"},"description":"The organization ids to either add or remove permissions for."},"is_include_only_list":{"type":"boolean","description":"If true the user will only have access to organization_permission_ids. If false, it will prevent access to the organizations in organization_permission_ids."},"mfa_enabled":{"type":"boolean","description":"MFA is enabled for the user"}},"description":"OrganizationUser resource"},"OrganizationUserSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/OrganizationUser"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"Associated with an organization"}}}],"description":"Organization User specification"},"OrganizationCreate":{"type":"object","properties":{"name":{"type":"string","description":"Organization legal name"},"billing_contact_name":{"type":"string","description":"Contact name"},"billing_contact_phone":{"type":"string","description":"Contact phone"},"billing_contact_email":{"type":"string","description":"Contact email"},"address":{"type":"string","description":"Legal address"},"managed_by_msp_id":{"type":"integer","description":"Organization is managed by the specified MSP"},"unique_id":{"type":"string","description":"Used to determine custom login url for enterprise connections"},"sku":{"type":"string","description":"SKU for plan type selected"},"quantity":{"type":"integer","description":"Number of licenses to assign"},"vpn_settings_organization_attributes":{"type":"object","properties":{"id":{"type":"integer"},"vpn_settings_state_type_id":{"type":"integer"},"_destroy":{"type":"boolean"}},"description":"Vpn organization settings"},"privacy_mode":{"type":"string","enum":["inherit","standard","identify_devices","maximum"],"description":"Privacy mode for the organization, either"},"enable_cybersight":{"type":"boolean","description":"This will only enable access if the organization is entitled to CyberSight"}},"required":["name","managed_by_msp_id"],"description":"Organization creation request parameters"},"OrganizationCreateSpec":{"type":"object","properties":{"organization":{"$ref":"#/components/schemas/OrganizationCreate"}},"required":["organization"],"description":"Organization creation request parameters"},"OrganizationUserCreate":{"type":"object","properties":{"email":{"type":"string","description":"Email address"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"phone":{"type":"string","description":"Phone number"},"role":{"type":"string","description":"One of \"administrator\", \"read_only\""},"organization_permission_ids":{"type":"array","items":{"type":"integer"},"description":"The organization ids to either add or remove permissions for."},"is_include_only_list":{"type":"boolean","description":"If true the user will only have access to organization_permission_ids. If false, it will prevent access to the organizations in organization_permission_ids."}},"description":"OrganizationUser create request parameters"},"OrganizationUserCreateSpec":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/OrganizationUserCreate"}},"required":["user"],"description":"OrganizationUser creation request parameters"},"OrganizationBulkUpdate":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs to update"},"msp_id":{"type":"integer","description":"MSP ID, scope update to all accessable sub-orgs (overrides organization_ids)"},"exclude_organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs to exclude"},"send_uninstall_notifications_to_admin_users":{"type":"boolean","description":"True if uninstall notifications should be sent to admin users"},"user_agent_uninstall_notification":{"type":"boolean","description":"True if user agents uninstalls should trigger notification"},"user_agent_uninstall_notification_recipient_emails":{"type":"array","items":{"type":"string"},"description":"Recipients to receive uninstalled user agent notifications"},"user_agents_auto_update":{"type":"boolean","description":"True if user agents will auto update"},"vpn_settings_organization_attributes":{"type":"object","properties":{"vpn_settings_state_type_id":{"type":"integer"}},"description":"Vpn organization settings"}},"description":"Organization bulk update parameters"},"OrganizationV2CreateSpec":{"type":"object","properties":{"address":{"type":"string","description":"Organization legal address"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"managed_by_msp_id":{"type":"integer","description":"Organization is managed by the specified MSP"},"name":{"type":"string","description":"Organization legal name"},"quantity":{"type":"integer","description":"Number of licenses to assign"},"sku":{"type":"string","description":"SKU for plan type selected"},"enable_cybersight":{"type":"boolean","description":"Enable CyberSight for the organization (if entitled)"}},"required":["name","quantity","sku"],"description":"Organization create request parameters for v2 API"},"OrganizationV2BulkUpdate":{"type":"object","properties":{"id":{"type":"integer","description":"Organization IDs"},"address":{"type":"string","description":"Organization legal address"},"external_id":{"type":"string","description":"A unique identifier for external integrations"},"name":{"type":"string","description":"Organization legal name"},"quantity":{"type":"integer","description":"Number of licenses to assign"},"sku":{"type":"string","description":"SKU for plan type selected"}},"description":"Organization create request parameters for v2 API"},"OrganizationV2BulkUpdateSpec":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationV2BulkUpdate"},"description":"Organization information"}},"required":["organizations"],"description":"Organization create request parameters for v2 API"},"OrganizationV2ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"},"description":"Error messages"},"id":{"type":"integer","description":"Organization ID that failed to update"}}},"WithCyberSightAccess":{"type":"object","properties":{"orgs_with_access":{"$ref":"#/components/schemas/BasicOrganizationInfo"},"orgs_without_access":{"$ref":"#/components/schemas/BasicOrganizationInfo"}}},"BasicOrganizationInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Organization id"},"name":{"type":"string","description":"Organization name"}}},"Plan":{"type":"object","properties":{"name":{"type":"string","description":"Plan name"},"description":{"type":"string","description":"Plan description"}},"description":"Plan resource"},"PlanSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Plan"}}}],"description":"Plan specification"},"Policy":{"type":"object","properties":{"name":{"type":"string","description":"Policy name"},"organization_id":{"type":"integer","description":"Organization ID"},"whitelist_domains":{"type":"array","items":{"type":"string"},"description":"Allowlisted domains"},"blacklist_domains":{"type":"array","items":{"type":"string"},"description":"Blocklisted domains"},"blacklist_categories":{"type":"array","items":{"type":"integer"},"description":"Blocklisted categories"},"allow_unknown_domains":{"type":"boolean","description":"Allow unknown domains yes/no"},"google_safesearch":{"type":"boolean","description":"Force Google safe search yes/no"},"bing_safe_search":{"type":"boolean","description":"Force Bing safe search yes/no"},"duck_duck_go_safe_search":{"type":"boolean","description":"Force Duck Duck Go safe search yes/no"},"ecosia_safesearch":{"type":"boolean","description":"Force Ecosia safe search yes/no"},"yandex_safe_search":{"type":"boolean","description":"Force Yandex safe search yes/no"},"youtube_restricted":{"type":"boolean","description":"YouTube blocked yes/no"},"youtube_restricted_level":{"type":"string","enum":["strict","none"],"description":"YouTube restricted level"},"interstitial":{"type":"boolean","description":"Interstitial page enabled yes/no"},"is_global_policy":{"type":"boolean","description":"Policy is a global policy yes/no"},"can_edit":{"type":"boolean","description":"Current user can edit the policy yes/no"},"lock_version":{"type":"integer","description":"Object version"},"allow_list_only":{"type":"boolean","description":"If true, only domains on the allow list will be allowed. All others will be blocked regardless of configuration."}},"description":"Policy resource"},"PolicyHistory":{"type":"object","properties":{"created_at":{"type":"string","format":"date","description":"Event creation date"},"event":{"type":"string","description":"Event type (create, update, delete, etc.)"},"object_changes":{"$ref":"#/components/schemas/PolicyHistoryAttributes"}},"description":"Policy history resource"},"PolicyHistoryAttributes":{"type":"object","properties":{"id":{"type":"array","items":{"type":"integer"},"description":"Two size array, with old and new value (can be `null`)"},"name":{"type":"array","items":{"type":"string"},"description":"Two size array, with old and new value (can be `null`)"},"created_at":{"type":"array","items":{"type":"string","format":"date"},"description":"Two size array, with old and new value (can be `null`)"},"updated_at":{"type":"array","items":{"type":"string","format":"date"},"description":"Two size array, with old and new value (can be `null`)"},"organization_id":{"type":"array","items":{"type":"integer"},"description":"Two size array, with old and new value (can be `null`)"},"blacklist_domains":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Two size array, with old and new value (can be `null`)"},"whitelist_domains":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Two size array, with old and new value (can be `null`)"},"blacklist_categories":{"type":"array","items":{"type":"array","items":{"type":"integer"}},"description":"Two size array, with old and new value (can be `null`)"}},"description":"Policy history attributes"},"PolicyHistorySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PolicyHistory"},"relationships":{"type":"object","properties":{"user":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"association_versions":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Policy associated history"}}}],"description":"Policy history specification"},"PolicyIp":{"type":"object","properties":{"friendly_id":{"type":"integer","description":"Policy IP ID"},"primary_address":{"type":"string","description":"NAT primary address"},"secondary_address":{"type":"string","description":"NAT secondary address"}},"description":"Policy IP resource"},"PolicyIpSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/PolicyIp"}}}],"description":"Policy IP specification"},"PolicyRelationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}},"description":"Policy associated organization"},"network_policies":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}},"description":"Policy associated network policies"},"networks":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}},"description":"Policy associated networks"}},"description":"Policy related information"},"PolicySpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Policy"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"network_policies":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}},"networks":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Policy associated resources"}}}],"description":"Policy specification"},"ScheduledPolicy":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"organization_id":{"type":"integer","description":"The organization that owns the block page"},"policy_ids":{"type":"array","items":{"type":"integer"},"description":"672 ids representing 15 minute blocks starting Monday morning 12:01am"},"timezone":{"type":"string","description":"The timezone string (e.g. America/New_York) for localizing the policy"}},"description":"Represents a time based policy"},"PolicyCreate":{"type":"object","properties":{"name":{"type":"string","description":"Policy name"},"organization_id":{"type":"integer","description":"Organization ID"},"allow_unknown_domains":{"type":"boolean","description":"Allow unknown domains yes/no"},"google_safesearch":{"type":"boolean","description":"Force Google safe search yes/no"},"bing_safe_search":{"type":"boolean","description":"Force Bing safe search yes/no"},"duck_duck_go_safe_search":{"type":"boolean","description":"Force Duck Duck Go safe search yes/no"},"ecosia_safesearch":{"type":"boolean","description":"Force Ecosia safe search yes/no"},"youtube_restricted":{"type":"boolean","description":"YouTube blocked yes/no"},"youtube_restricted_level":{"type":"string","enum":["strict","none"],"description":"YouTube restricted level"},"interstitial":{"type":"boolean","description":"Interstitial page enabled yes/no"},"policy_ip_id":{"type":"integer","description":"Policy IP ID"},"whitelist_domains":{"type":"array","items":{"type":"string"},"description":"Allowlisted domains"},"blacklist_domains":{"type":"array","items":{"type":"string"},"description":"Blocklisted domains"},"blacklist_categories":{"type":"array","items":{"type":"integer"},"description":"Blocklisted categories"},"is_global_policy":{"type":"boolean","description":"Global Policy"},"allow_applications":{"type":"array","items":{"type":"string"},"description":"Allowed applications"},"block_applications":{"type":"array","items":{"type":"string"},"description":"Blocked applications"},"lock_version":{"type":"integer","description":"Object version"},"yandex_safe_search":{"type":"boolean","description":"Force Yandex safe search yes/no"},"allow_list_only":{"type":"boolean","description":"If true, only domains on the allow list will be allowed. All others will be blocked regardless of configuration."}},"required":["name","organization_id"],"description":"Policy creation request parameters"},"PolicyCreateSpec":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyCreate"},"include_relationships":{"type":"boolean","description":"Include relationships in the response true/false, defaults to true"},"append_domains":{"type":"boolean","description":"Option to append allowlist/blocklist domains to the existing ones. Default: false"}},"required":["policy"],"description":"Policy creation request parameters"},"PolicyIpCreate":{"type":"object","properties":{"id":{"type":"integer","description":"Policy IP ID"},"primary_address":{"type":"string","description":"NAT primary address"},"secondary_address":{"type":"string","description":"NAT secondary address"}},"required":["id","primary_address","secondary_address"],"description":"Policy IP creation request parameters"},"PolicyIpCreateSpec":{"type":"object","properties":{"policy_ip":{"$ref":"#/components/schemas/PolicyIpCreate"}},"required":["policy_ip"],"description":"Policy IP creation request parameters"},"PolicyNotesCreateSpec":{"type":"object","properties":{"type":{"type":"string","enum":["allow","block"],"description":"Type of notes (allow, block), defaults to allow"},"domain":{"type":"string","description":"Allow/block list domain"},"note":{"type":"string","description":"Notes for domain"}},"required":["type","domain"],"description":"Policy Notes creation request parameters"},"PolicyUpdateSingleApplicationSpec":{"type":"object","properties":{"name":{"type":"string","description":"Application name"},"include_relationships":{"type":"boolean","description":"Include relationships in the response true/false, defaults to true"}},"required":["name"],"description":"Policy single application update request parameters"},"PolicyUpdateSingleCategorySpec":{"type":"object","properties":{"category_id":{"type":"integer","description":"Category ID"},"include_relationships":{"type":"boolean","description":"Include relationships in the response true/false, defaults to true"}},"required":["category_id"],"description":"Policy single category update request parameters"},"PolicyUpdateSingleDomainSpec":{"type":"object","properties":{"domain":{"type":"string","description":"Domain"},"note":{"type":"string","description":"Note"},"include_relationships":{"type":"boolean","description":"Include relationships in the response true/false, defaults to true"}},"required":["domain","note"],"description":"Policy single domain update request parameters"},"PolicyApplicationSpec":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"},"organization":{"$ref":"#/components/schemas/Organization"},"allow_policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicySpec"},"description":"List of Policies allowed for an application"},"block_policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicySpec"},"description":"List of Policies blocked for an application"}},"description":"Application policies response"},"PolicyNotesSpec":{"type":"object","properties":{"allow_notes":{"type":"object","description":"Notes for policy allowed domains"},"block_notes":{"type":"object","description":"Notes for policy blocked domains"}},"description":"Policy notes response"},"PolicyPermissiveModeSpec":{"type":"object","properties":{"permissive_mode":{"type":"boolean","description":"Policy's permissive mode value"}},"description":"Policy permissive mode response"},"PolicyBulkActionListDomains":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"description":"Domains to add/remove"},"notes":{"type":"object","properties":{"string":{"type":"string"}},"description":"Domain/Note key/values"},"policy_ids":{"type":"array","items":{"type":"integer"},"description":"Policy IDs to operate on"}},"description":"Payload for policy bulk actions for allow/block lists"},"PolicyBulkActionsListDomainsResponse":{"type":"object","properties":{"success":{"type":"array","items":{"type":"integer"},"description":"Policy IDs that were successfully updated"},"failure":{"type":"array","items":{"type":"integer"},"description":"Policy IDs that failed to update"},"noop":{"type":"array","items":{"type":"integer"},"description":"Policy IDs that required no update"}},"description":"Response for policy bulk actions for allow/block lists"},"RcDiagnosticReport":{"type":"object","properties":{"user_agent_id":{"type":"string","description":"The user agent id"},"status":{"type":"string","enum":["requested","received","started","completed","shared"],"description":"Status of report"},"received_at":{"type":"string","format":"date","description":"Datetime received by agent"},"started_at":{"type":"string","format":"date","description":"Datetime report started by agent"},"completed_at":{"type":"string","format":"date","description":"Datetime report is completed"},"shared_at":{"type":"string","format":"date","description":"Datetime report is shared by agent"},"error_message":{"type":"string","description":"Error message from agent, if any"},"object_key":{"type":"string","description":"Object key of generated report uploaded to s3"}},"description":"rc diagnostic report resource"},"RcDiagnosticReportSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/RcDiagnosticReport"}}}],"description":"Rc diagnostic report specification"},"RcDiagnosticReportUpdate":{"type":"object","properties":{"user_agent_id":{"type":"string","description":"The user agent that should be changing the status"},"status":{"type":"string","enum":["requested","received","started","completed","shared"],"description":"Status of report"},"error_message":{"type":"string","description":"Error message from agent, if any"}},"description":"Rc diagnostic report update params"},"ReportExport":{"type":"object","properties":{"id":{"type":"integer","description":"Exported report ID"},"report_type":{"type":"string","description":"Report type"},"format":{"type":"string","description":"Requested file format"},"status":{"type":"string","description":"Generation status"},"created_at":{"type":"string","format":"date","description":"Report creation date"},"started_at":{"type":"string","format":"date","description":"Date on which the report processing started"},"ended_at":{"type":"string","format":"date","description":"Date on which the report processing ended"},"available_until":{"type":"string","format":"date","description":"Maximum date the report will be available for download"},"row_count":{"type":"integer","description":"Number of rows that the report file contains"},"file":{"type":"object","properties":{"name":{"type":"string"},"size":{"type":"integer"},"extension":{"type":"string"},"url":{"type":"string"}},"description":"Generated file basic information"}},"description":"ReportExport resource"},"ReportExportSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ReportExport"},"relationships":{"type":"object","properties":{"user":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdType"}}}}},"description":"Report associated user"}}}],"description":"Report export specification"},"ReportExportCreate":{"type":"object","properties":{"report_type":{"type":"string","enum":["top_domains","threats","raw"],"description":"Report type to be generated"},"format":{"type":"string","enum":["csv"],"description":"Desired file format"},"filters":{"type":"string","description":"JSON object that contains the report filters"}},"required":["report_type","format","filters"],"description":"Report export creation request parameters"},"ReportExportCreateSpec":{"type":"object","properties":{"report_export":{"$ref":"#/components/schemas/ReportExportCreate"}},"required":["report_export"],"description":"Report information creation request parameters"},"ScheduledReport":{"type":"object","properties":{"organization_id":{"type":"integer","description":"The organization that owns the scheduled report"},"frequency":{"type":"string","enum":["monthly","bi_weekly","weekly"],"description":"Frequency of report"},"day_of_week":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"description":"Day of week report is sent"},"include_threat_summary":{"type":"boolean","description":"Report includes threat summary if true"},"include_content_category_summary":{"type":"boolean","description":"Report include content category summary if true"},"content_categories_show_count":{"type":"string","enum":["all_categories","top5","top10","top15"],"description":"Number of categories to show"},"send_to_dashboard_users":{"type":"boolean","description":"Report is sent to all dashboard users if true"},"scheduled_report_recipients":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledReportRecipient"},"description":"Scheduled report associated recipients"},"selected_sub_orgs":{"type":"array","items":{"type":"integer"},"description":"selected sub orgs for scheduled reports on msp organizations"}},"description":"Scheduled report resource"},"ScheduledReportPreview":{"allOf":[{"$ref":"#/components/schemas/ScheduledReportPreviewCreate"},{"type":"object","properties":{"url":{"type":"string","description":"A presigned url to the report that will expire in 10 minutes. Blank if report isn't yet generated"}}}],"description":"Scheduled report preview resource"},"ScheduledReportPreviewSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ScheduledReportPreview"}}}],"description":"Scheduled report preview specification"},"ScheduledReportRecipient":{"type":"object","properties":{"email":{"type":"string","description":"Email address of recipient"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Scheduled report recipient associated objects"}},"description":"Scheduled report recipient resource"},"ScheduledReportSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/ScheduledReport"}}}],"description":"Scheduled report specification"},"ScheduledReportPreviewCreate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"The organization that owns the scheduled report"},"include_threat_summary":{"type":"boolean","description":"Report includes threat summary if true"},"include_content_category_summary":{"type":"boolean","description":"Report include content category summary if true"},"content_categories_show_count":{"type":"string","enum":["all_categories","top5","top10","top15"],"description":"Number of categories to show"}},"description":"Scheduled report preview creation params"},"ScimUser":{"type":"object","properties":{"scim_meta":{"type":"object","description":"generic json meta object"},"id":{"type":"integer","description":"id of the user"},"onPremId":{"type":"string","description":"SCIM client provided on premise identifier of the user"},"username":{"type":"string","description":"SCIM client provided username"},"schemas":{"type":"array","items":{"type":"string"},"description":"schema list"}},"description":"Scim User Resource"},"ScimListResponse":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"description":"schema list"},"total_results":{"type":"integer","description":"total possible results found in query"},"resources":{"type":"array","items":{"type":"object"},"description":"list of resources found"},"start_index":{"type":"integer","description":"start index"}},"description":"Container for query responses for SCIM resources"},"ScimUserListResponse":{"allOf":[{"$ref":"#/components/schemas/ScimListResponse"},{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/ScimUser"},"description":"list of resources found"}}}],"description":"Container for query responses for SCIM user resources"},"ScimError":{"type":"object","properties":{"status":{"type":"string","description":"status code"},"details":{"type":"string","description":"Optional details associated to the error message"},"schemas":{"type":"array","items":{"type":"string"},"description":"scim schema errors"}},"description":"Error response returned from a scim related query"},"CreateScimUserRequest":{"type":"object","properties":{"userName":{"type":"string","description":"principle user name"},"active":{"type":"boolean","description":"if the user is active"},"displayName":{"type":"string","description":"friendly name of the user"},"meta":{"type":"object","description":"meta json object as required by Entra"},"urn:ietf:params:scim:schemas:extension:DNSF:2.0:User":{"type":"object","properties":{"objectSid":{"type":"string"}},"description":"on premise sid if required"}}},"History":{"type":"object","properties":{"id":{"type":"string","description":"Resource Id (integer or uuid)"},"type":{"type":"string","description":"Resource type name"}},"description":"History basic attributes"},"IdType":{"type":"object","properties":{"id":{"type":"string","description":"Resource Id (integer or uuid)"},"type":{"type":"string","description":"Resource type name"},"uuid":{"type":"string","description":"Resource UUID (if applicable)"}},"description":"JSON API resource ID and type attributes"},"Links":{"type":"object","properties":{"self":{"type":"string","description":"Endpoint URL (may be null)"}},"description":"JSON API links member representation"},"Success":{"type":"object","properties":{"success":{"type":"boolean","description":"Successful operation yes/no"}},"description":"Success basic representation"},"Entitlement":{"type":"object","properties":{"key":{"type":"integer","description":"Entitlement unique key"},"name":{"type":"string","description":"Entitlement friendly name"}},"description":"Entitlement resource"},"Sku":{"type":"object","properties":{"sku":{"type":"string","description":"SKU"},"name":{"type":"string","description":"SKU name"},"addon":{"type":"boolean","description":"Is an addon yes/no"},"term":{"type":"string","enum":["monthly","annual"],"description":"SKU term"},"weight":{"type":"number","format":"float","description":"SKU weight"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/Entitlement"},"description":"Entitlements the SKU gives access to"}},"description":"Sku resource"},"Subscription":{"type":"object","properties":{"plan":{"type":"string","description":"Plan name"},"term":{"type":"string","description":"Plan subscription term"},"user_count":{"type":"integer","description":"User count"},"wifi_count":{"type":"integer","description":"Wi-Fi count"},"status":{"type":"string","description":"Subscription status"},"plan_total_cents":{"type":"integer","description":"Subscription total cents per term period"},"started_at":{"type":"string","description":"Subscription start date"},"cancelled_at":{"type":"string","description":"Subscription cancellation date"},"next_billing_at":{"type":"string","description":"Next charge date"},"current_term_start":{"type":"string","description":"Current term period start date"},"current_term_end":{"type":"string","description":"Current term period end date"},"due_invoices_count":{"type":"integer","description":"Total number of due invoices"},"due_since":{"type":"string","description":"Due start date"},"dues_total_cents":{"type":"integer","description":"Total cents of dues"},"organization_id":{"type":"integer","description":"Organization ID"},"organization_info":{"type":"object","properties":{"name":{"type":"string"},"addons":{"type":"array","items":{"type":"string"}}},"description":"Organization information"},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"user_count":{"type":"integer"},"wifi_count":{"type":"integer"}}},"description":"Beneficiaries information"}},"description":"User agent resource"},"SubscriptionSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Subscription"},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"Subscription associated objects"}}}],"description":"Subscription specification"},"SubscriptionBeneficiariesBatchSpec":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID, owner of the subscription"},"beneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionBeneficiary"},"description":"Organization ID, owner of the subscription"},"addons":{"type":"array","items":{"type":"string","enum":["data-export-basic-monthly","data-export-basic-annual","data-export-pro-monthly","data-export-pro-annual","data-export-enterprise-monthly","data-export-enterprise-annual","data-export-legacy-monthly"]},"description":"Addon list"}},"description":"Subscriptions batch update information"},"SubscriptionBeneficiary":{"type":"object","properties":{"id":{"type":"integer","description":"Organization ID, beneficiary of the subscription plan/term"},"user_count":{"type":"integer","description":"User count"},"wifi_count":{"type":"integer","description":"Wi-Fi/APs count"},"plan":{"type":"string","description":"Plan name"},"term":{"type":"string","description":"Plan subscription term"}},"description":"Subscription beneficiary information"},"BatchListSpec":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"List of Sync Tool Collection or Group IDs [Max: 50]."},"organization_id":{"type":"integer","description":"Organization ID."}},"description":"Request payload for a list of Sync Tool Collections or Groups\nby IDs"},"CombinedMetaSpec":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of objects."},"total_pages":{"type":"integer","description":"Total number of pages."},"current_page":{"type":"integer","description":"Current page number."}},"description":"Pagination metadata for Combined List"},"CombinedSpec":{"type":"object","properties":{"id":{"type":"integer","description":"Collection or Group ID."},"name":{"type":"string","description":"Name of Collection or Group."},"distinguished_name":{"type":"string","description":"Distinguished name of Collection or Group."},"remote_id":{"type":"string","description":"Remote ID of Collection or Group."},"parent_id":{"type":"number","description":"Parent Collection."},"organization_id":{"type":"number","description":"Organization ID."},"deleted_at":{"type":"string","format":"date-time","description":"Date and time of deletion."},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation."},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update."},"first_sync":{"type":"string","format":"date-time","description":"Date and time of first sync."},"last_sync":{"type":"string","format":"date-time","description":"Date and time of last sync."},"group_type":{"type":"string","enum":["group","collection"],"description":"Collection or Group."},"users_count":{"type":"integer","description":"Count of direct users in Collection or Group."}},"description":"Sync Tool Collection or Group Specification"},"TrafficReportsPagination":{"type":"object","properties":{"size":{"type":"integer","description":"Number of rows per page"},"total":{"type":"integer","description":"Total number of rows in the result"},"first":{"type":"integer","description":"Number of the first page"},"last":{"type":"integer","description":"Number of the last page"},"self":{"type":"integer","description":"Number of the current page"},"prev":{"type":"integer","description":"Number of the previous page (if any) (may be null)"},"next":{"type":"integer","description":"Number of the next page (if any) (may be null)"}},"description":"Traffic reports pagination response"},"TrafficReportsQps":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQpsResult"},"description":"Result data of the report"}},"description":"Traffic reports QPS for networks endpoint"},"TrafficReportsQpsActiveAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"String list of user agents UUIDs that are contained in the response"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQpsActiveAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports QPS for agents endpoint"},"TrafficReportsQpsActiveAgentsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID"},"agent_name":{"type":"string","description":"User agent name"},"bucket":{"type":"string","description":"Bucket datetime in UTC, bucket size is one minute"},"qps":{"type":"number","format":"float","description":"Total QPS in the bucket (all values are rounded to one decimal)"},"qps_networks":{"type":"number","format":"float","description":"Total QPS in the bucket made by networks only (all values are rounded to one decimal)"},"qps_proxies":{"type":"number","format":"float","description":"Total QPS in the bucket made by LAN proxies only (all values are rounded to one decimal)"},"qps_agents":{"type":"number","format":"float","description":"Total QPS in the bucket made by user agents only (all values are rounded to one decimal)"}},"description":"Traffic reports QPS for agents endpoint"},"TrafficReportsQpsActiveCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQpsActiveCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports QPS for collections endpoint"},"TrafficReportsQpsActiveCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"bucket":{"type":"string","description":"Bucket datetime in UTC, bucket size is one minute"},"qps":{"type":"number","format":"float","description":"Total QPS in the bucket (all values are rounded to one decimal)"},"qps_networks":{"type":"number","format":"float","description":"Total QPS in the bucket made by networks only (all values are rounded to one decimal)"},"qps_proxies":{"type":"number","format":"float","description":"Total QPS in the bucket made by LAN proxies only (all values are rounded to one decimal)"},"qps_agents":{"type":"number","format":"float","description":"Total QPS in the bucket made by user agents only (all values are rounded to one decimal)"}},"description":"Traffic reports QPS for collections endpoint"},"TrafficReportsQpsActiveOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQpsActiveOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports QPS for organizations endpoint"},"TrafficReportsQpsActiveOrganizationsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"bucket":{"type":"string","description":"Bucket datetime in UTC, bucket size is one minute"},"qps":{"type":"number","format":"float","description":"Total QPS in the bucket (all values are rounded to one decimal)"},"qps_networks":{"type":"number","format":"float","description":"Total QPS in the bucket made by networks only (all values are rounded to one decimal)"},"qps_proxies":{"type":"number","format":"float","description":"Total QPS in the bucket made by LAN proxies only (all values are rounded to one decimal)"},"qps_agents":{"type":"number","format":"float","description":"Total QPS in the bucket made by user agents only (all values are rounded to one decimal)"}},"description":"Traffic reports QPS for organizations endpoint"},"TrafficReportsQpsActiveUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"List of user IDs that are contained in the response"},"user_names":{"type":"array","items":{"type":"string"},"description":"User names"},"user_logins":{"type":"array","items":{"type":"string"},"description":"User logins"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQpsActiveUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports QPS for users endpoint"},"TrafficReportsQpsActiveUsersResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID"},"user_name":{"type":"string","description":"User name or friendly name"},"user_login":{"type":"string","description":"User remote login"},"bucket":{"type":"string","description":"Bucket datetime in UTC, bucket size is one minute"},"qps":{"type":"number","format":"float","description":"Total QPS in the bucket (all values are rounded to one decimal)"},"qps_networks":{"type":"number","format":"float","description":"Total QPS in the bucket made by networks only (all values are rounded to one decimal)"},"qps_proxies":{"type":"number","format":"float","description":"Total QPS in the bucket made by LAN proxies only (all values are rounded to one decimal)"},"qps_agents":{"type":"number","format":"float","description":"Total QPS in the bucket made by user agents only (all values are rounded to one decimal)"}},"description":"Traffic reports QPS for users endpoint"},"TrafficReportsQpsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"qps":{"type":"number","format":"float","description":"Total QPS in the bucket (all values are rounded to one decimal)"},"qps_networks":{"type":"number","format":"float","description":"Total QPS in the bucket made by networks only (all values are rounded to one decimal)"},"qps_proxies":{"type":"number","format":"float","description":"Total QPS in the bucket made by LAN proxies only (all values are rounded to one decimal)"},"qps_agents":{"type":"number","format":"float","description":"Total QPS in the bucket made by user agents only (all values are rounded to one decimal)"}},"description":"Traffic reports QPS for networks endpoint"},"TrafficReportsQueryLogs":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID of the result"},"organization_ids":{"type":"array","items":{"type":"string"},"description":"List of organization IDs of the result"},"organization_name":{"type":"string","description":"Organization name"},"organization_names":{"type":"array","items":{"type":"string"},"description":"List of organization name of the result"},"network_id":{"type":"integer","description":"Network ID of the result (may be null)"},"network_ids":{"type":"array","items":{"type":"string"},"description":"List of network IDs of the result (may be null)"},"client_id":{"type":"string","description":"User agent UUID of the result (may be null)"},"client_ids":{"type":"array","items":{"type":"string"},"description":"List of user agent UUIDs of the result (may be null)"},"user_id":{"type":"integer","description":"User local ID of the result (may be null)"},"user_ids":{"type":"array","items":{"type":"string"},"description":"List of user local IDs of the result (may be null)"},"collection_id":{"type":"integer","description":"Collection ID of the result (may be null)"},"collection_ids":{"type":"array","items":{"type":"string"},"description":"List of collection IDs of the result (may be null)"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsQueryLogsResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports query log endpoint"},"TrafficReportsQueryLogsResult":{"type":"object","properties":{"time":{"type":"string","description":"DNS request datetime in UTC"},"fqdn":{"type":"string","description":"Requested FQDN"},"networkid":{"type":"integer","description":"Network ID"},"request_address":{"type":"string","description":"IP address of the requester"},"domain":{"type":"string","description":"Domain of the FQDN"},"result":{"type":"string","enum":["allowed","blocked"],"description":"Result of the requested FQDN"},"threat":{"type":"boolean","description":"threat request"},"categories":{"type":"array","items":{"type":"integer"},"description":"Matched categories IDs for the FQDN"},"server_id":{"type":"integer","description":"ID of the server that received the request"},"server_address":{"type":"string","description":"IP address of the server that received the request"},"method":{"type":"integer","description":"Matched method ID for the FQDN"},"responsetime":{"type":"integer","description":"request response time in milliseconds"},"agentid":{"type":"string","description":"User agent UUID (may be null)"},"agentname":{"type":"string","description":"User agent name (may be null)"},"agenttype":{"type":"string","enum":["proxy","agent"],"description":"User agent type (may be null)"},"agent_type_raw":{"type":"string","description":"User agent raw type (may be null)"},"local_ipv4_address":{"type":"string","description":"User agent local IPv4 address (may be null)"},"local_ipv6_address":{"type":"string","description":"User agent local IPv6 address (may be null)"},"local_user_id":{"type":"integer","description":"Local User ID (may be null)"},"local_user_remote_id":{"type":"string","description":"User remote ID (may be null)"},"local_user_login":{"type":"string","description":"User remote login (may be null)"},"local_user_name":{"type":"string","description":"User remote user name (may be null)"},"lan_device_name":{"type":"string","description":"Local device name (may be null)"},"network_name":{"type":"string","description":"Network name"},"server_name":{"type":"string","description":"Server name"},"method_name":{"type":"string","description":"Method name"},"categories_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"policy_id":{"type":"integer","description":"Applied policy ID (may be null)"},"policy_name":{"type":"string","description":"Applied policy name (may be null)"},"scheduled_policy_id":{"type":"integer","description":"Applied scheduled policy ID (may be null)"},"scheduled_policy_name":{"type":"string","description":"Applied scheduled policy name (may be null)"},"collection_id":{"type":"integer","description":"Applied collection ID (may be null)"},"collection_name":{"type":"string","description":"Applied collection name (may be null)"},"collections":{"type":"array","items":{"type":"integer"},"description":"User collections IDs (may be null)"},"collections_names":{"type":"array","items":{"type":"string"},"description":"User collections names (may be null)"},"mac_address":{"type":"string","description":"Client MAC address (may be null)"},"application_id":{"type":"integer","description":"Application ID (may be null)"},"application_name":{"type":"string","description":"Application name (may be null)"},"application_category_id":{"type":"integer","description":"Application category ID (may be null)"},"application_category_name":{"type":"string","description":"Application category name (may be null)"},"protocol":{"type":"string","description":"Protocol (may be null)"},"question_type":{"type":"string","description":"Question type (may be null)"},"response_ips":{"type":"array","items":{"type":"string"},"description":"Resolved IP addresses returned in the DNS response (may be null)"},"region":{"type":"string","description":"Region (may be null)"}},"description":"Traffic reports query log endpoint"},"TrafficReportsTopAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopAgentsResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top agents endpoint"},"TrafficReportsTopAgentsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID"},"agent_type":{"type":"string","description":"User agent type"},"agent_name":{"type":"string","description":"User agent name"},"total":{"type":"integer","description":"Total number of requests"},"total_networks":{"type":"integer","description":"Total number of requests made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests made by user agents only"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"}},"description":"Traffic reports top agents endpoint"},"TrafficReportsTopApplicationCategories":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopApplicationCategoriesResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top application categories endpoint"},"TrafficReportsTopApplicationCategoriesResult":{"type":"object","properties":{"application_category_id":{"type":"integer","description":"Application category ID"},"application_category_name":{"type":"string","description":"Application category name"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"organizations":{"type":"array","items":{"type":"integer"},"description":"Organizations who made the request"},"networks":{"type":"array","items":{"type":"integer"},"description":"Networks who made the request"},"agents":{"type":"array","items":{"type":"string"},"description":"User agents who made the request"},"collections":{"type":"array","items":{"type":"integer"},"description":"Collections who made the request"},"users":{"type":"array","items":{"type":"integer"},"description":"Users who made the request"},"total":{"type":"integer","description":"Total number of requests for the category"},"total_networks":{"type":"integer","description":"Total number of requests for the category made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests for the category made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests for the category made by user agents only"}},"description":"Traffic reports top application categories endpoint"},"TrafficReportsTopCategories":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopCategoriesResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top categories endpoint"},"TrafficReportsTopCategoriesResult":{"type":"object","properties":{"categoryid":{"type":"integer","description":"Category ID (deprecated)"},"category_id":{"type":"integer","description":"Category ID"},"category_name":{"type":"string","description":"Category name"},"methods":{"type":"array","items":{"type":"integer"},"description":"Matched methods ID for the category"},"methods_names":{"type":"array","items":{"type":"string"},"description":"Matched methods names"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"organizations":{"type":"array","items":{"type":"integer"},"description":"Organizations who made the request"},"networks":{"type":"array","items":{"type":"integer"},"description":"Networks who made the request"},"agents":{"type":"array","items":{"type":"string"},"description":"User agents who made the request"},"collections":{"type":"array","items":{"type":"integer"},"description":"Collections who made the request"},"users":{"type":"array","items":{"type":"integer"},"description":"Users who made the request"},"total":{"type":"integer","description":"Total number of requests for the category"},"total_networks":{"type":"integer","description":"Total number of requests for the category made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests for the category made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests for the category made by user agents only"}},"description":"Traffic reports top categories endpoint"},"TrafficReportsTopCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopCollectionsResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top collections endpoint"},"TrafficReportsTopCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"total":{"type":"integer","description":"Total number of requests"},"total_networks":{"type":"integer","description":"Total number of requests made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests made by user agents only"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"}},"description":"Traffic reports top collections endpoint"},"TrafficReportsTopDomains":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopDomainsResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top domains endpoint"},"TrafficReportsTopDomainsResult":{"type":"object","properties":{"domain":{"type":"string","description":"Domain of the requested FQDN"},"total":{"type":"integer","description":"Total number of requests to the domain"},"total_networks":{"type":"integer","description":"Total number of requests to the domain made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests to the domain made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests to the domain made by user agents only"},"allowed":{"type":"array","items":{"type":"integer"},"description":"Matched allowed categories IDs for the domain"},"allowed_names":{"type":"array","items":{"type":"string"},"description":"Matched allowed categories names"},"blocked":{"type":"array","items":{"type":"integer"},"description":"Matched blocked categories IDs for the domain"},"blocked_names":{"type":"array","items":{"type":"string"},"description":"Matched blocked categories names"},"methods":{"type":"array","items":{"type":"integer"},"description":"Matched methods ID for the domain"},"methods_names":{"type":"array","items":{"type":"string"},"description":"Matched methods names"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"organizations":{"type":"array","items":{"type":"integer"},"description":"Organizations who made the request"},"networks":{"type":"array","items":{"type":"integer"},"description":"Networks who made the request"},"agents":{"type":"array","items":{"type":"string"},"description":"User agents who made the request"},"collections":{"type":"array","items":{"type":"integer"},"description":"Collections who made the request"},"users":{"type":"array","items":{"type":"integer"},"description":"Users who made the request"}},"description":"Traffic reports top domains endpoint"},"TrafficReportsTopNetworks":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopNetworksResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top networks endpoint"},"TrafficReportsTopNetworksResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Network ID"},"network_name":{"type":"string","description":"Network name"},"total":{"type":"integer","description":"Total number of requests"},"total_networks":{"type":"integer","description":"Total number of requests made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests made by user agents only"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"}},"description":"Traffic reports top networks endpoint"},"TrafficReportsTopOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopOrganizationsResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top organizations endpoint"},"TrafficReportsTopOrganizationsRequests":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopOrganizationsRequestsResult"},"description":"Result data of the report"}},"description":"Traffic reports to get the top organizations by number of requests"},"TrafficReportsTopOrganizationsRequestsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"total_requests":{"type":"integer","description":"Number of total requests"}},"description":"Traffic reports top organizations endpoint"},"TrafficReportsTopOrganizationsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"total":{"type":"integer","description":"Total number of requests"},"total_networks":{"type":"integer","description":"Total number of requests made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests made by user agents only"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"}},"description":"Traffic reports top organizations endpoint"},"TrafficReportsTopUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"List of user IDs that are contained in the response"},"user_names":{"type":"array","items":{"type":"string"},"description":"User names"},"user_logins":{"type":"array","items":{"type":"string"},"description":"User logins"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTopUsersResult"},"description":"Result data of the report"},"page":{"$ref":"#/components/schemas/TrafficReportsPagination"}},"description":"Traffic reports top users endpoint"},"TrafficReportsTopUsersResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID"},"user_name":{"type":"string","description":"User name or friendly name"},"user_login":{"type":"string","description":"User remote login"},"total":{"type":"integer","description":"Total number of requests"},"total_networks":{"type":"integer","description":"Total number of requests made by networks only"},"total_proxies":{"type":"integer","description":"Total number of requests made by LAN proxies only"},"total_agents":{"type":"integer","description":"Total number of requests made by user agents only"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"}},"description":"Traffic reports top users endpoint"},"TrafficReportsTotalApplicationsAgentsStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsAgentsStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications by agent stats endpoint"},"TrafficReportsTotalApplicationsAgentsStatsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID"},"agent_type":{"type":"string","description":"User agent type"},"agent_name":{"type":"string","description":"User agent name"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Last seen bucket (UTC)"}},"description":"Traffic reports total applications by agent stats endpoint"},"TrafficReportsTotalApplicationsCollectionsStatsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Last seen bucket (UTC)"}},"description":"Traffic reports total applications by collection stats endpoint"},"TrafficReportsTotalApplicationsCollectionsStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsCollectionsStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications by collection stats endpoint"},"TrafficReportsTotalApplicationsNetworksStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsNetworksStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications by network stats endpoint"},"TrafficReportsTotalApplicationsNetworksStatsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Network ID"},"network_name":{"type":"string","description":"Network name"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Last seen bucket (UTC)"}},"description":"Traffic reports total applications by network stats endpoint"},"TrafficReportsTotalApplicationsOrganizationsStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsOrganizationsStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications by organization stats endpoint"},"TrafficReportsTotalApplicationsOrganizationsStatsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Last seen bucket (UTC)"}},"description":"Traffic reports total applications by organization stats endpoint"},"TrafficReportsTotalApplicationsStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications stats endpoint"},"TrafficReportsTotalApplicationsStatsResult":{"type":"object","properties":{"application_id":{"type":"integer","description":"Application ID"},"application_name":{"type":"string","description":"Application name"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Application last seen bucket (UTC)"},"application_category_id":{"type":"integer","description":"Application category ID"},"application_category_name":{"type":"string","description":"Application category name"}},"description":"Traffic reports total applications stats endpoint"},"TrafficReportsTotalApplicationsUsersStats":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalApplicationsUsersStatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total applications by user stats endpoint"},"TrafficReportsTotalApplicationsUsersStatsResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID"},"user_name":{"type":"string","description":"User name or friendly name"},"user_login":{"type":"string","description":"User remote login"},"total_requests":{"type":"integer","description":"Number of total requests"},"allowed_requests":{"type":"integer","description":"Number of allowed requests"},"blocked_requests":{"type":"integer","description":"Number of blocked requests"},"previous_total_requests":{"type":"integer","description":"Number of total requests for previous time period"},"most_recent_bucket":{"type":"string","description":"Last seen bucket (UTC)"}},"description":"Traffic reports total applications by user stats endpoint"},"TrafficReportsTotalCategories":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"category_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of categories IDs that are contained in the response"},"category_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by category for networks endpoint"},"TrafficReportsTotalCategoriesAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"category_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of categories IDs that are contained in the response"},"category_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by category for agents endpoint"},"TrafficReportsTotalCategoriesAgentsResult":{"type":"object","properties":{"category_id":{"type":"integer","description":"Bucket category ID"},"category_name":{"type":"string","description":"Category name"},"agent_id":{"type":"string","description":"User agent UUID (if grouped by agent) (may be null)"},"agent_type":{"type":"string","description":"User agent type (if grouped by agent) (may be null)"},"agent_name":{"type":"string","description":"User agent name (if grouped by agent) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by category for agents endpoint"},"TrafficReportsTotalCategoriesCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"category_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of categories IDs that are contained in the response"},"category_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by category for collections endpoint"},"TrafficReportsTotalCategoriesCollectionsResult":{"type":"object","properties":{"category_id":{"type":"integer","description":"Bucket category ID"},"category_name":{"type":"string","description":"Category name"},"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by category for collections endpoint"},"TrafficReportsTotalCategoriesOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"category_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of categories IDs that are contained in the response"},"category_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by category for organizations endpoint"},"TrafficReportsTotalCategoriesOrganizationsResult":{"type":"object","properties":{"category_id":{"type":"integer","description":"Bucket category ID"},"category_name":{"type":"string","description":"Category name"},"organization_id":{"type":"integer","description":"Organization ID (if grouped by organization) (may be null)"},"organization_name":{"type":"string","description":"Organization name (if grouped by organization) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by category for organizations endpoint"},"TrafficReportsTotalCategoriesResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"category_id":{"type":"integer","description":"Bucket category ID"},"category_name":{"type":"string","description":"Category name"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by category for networks endpoint"},"TrafficReportsTotalCategoriesUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"category_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of categories IDs that are contained in the response"},"category_names":{"type":"array","items":{"type":"string"},"description":"Categories names"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"List of user IDs that are contained in the response"},"user_names":{"type":"array","items":{"type":"string"},"description":"User names"},"user_logins":{"type":"array","items":{"type":"string"},"description":"User logins"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCategoriesUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by category for users endpoint"},"TrafficReportsTotalCategoriesUsersResult":{"type":"object","properties":{"category_id":{"type":"integer","description":"Bucket category ID"},"category_name":{"type":"string","description":"Category name"},"user_id":{"type":"integer","description":"User ID (if grouped by user) (may be null)"},"user_name":{"type":"string","description":"User name or friendly name (if grouped by user) (may be null)"},"user_login":{"type":"string","description":"User remote login (if grouped by user) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by category for users endpoint"},"TrafficReportsTotalCategoryStats":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"},"threat_requests":{"type":"integer","description":"Number of threat requests in the bucket"}},"description":"Traffic reports total number of stats for a category in a period of time"},"TrafficReportsTotalClientStats":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"total_users":{"type":"integer","description":"Number of users from an organization"},"active_users":{"type":"integer","description":"Number of active users from an organization"},"total_sites":{"type":"integer","description":"Number of sites from an organization"},"active_sites":{"type":"integer","description":"Number of active sites from an organization"},"total_roaming_clients":{"type":"integer","description":"Number of roaming clients from an organization or network"},"active_roaming_clients":{"type":"integer","description":"Number of active roaming clients from an organization or network"},"total_relays":{"type":"integer","description":"Number of relays from an organization or network"},"active_relays":{"type":"integer","description":"Number of active relays from an organization or network"}},"description":"Traffic reports total client stats endpoint"},"TrafficReportsTotalCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by collection for networks endpoint"},"TrafficReportsTotalCollectionsAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by collection for agents endpoint"},"TrafficReportsTotalCollectionsAgentsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"agent_id":{"type":"string","description":"User agent UUID (if grouped by agent) (may be null)"},"agent_type":{"type":"string","description":"User agent type (if grouped by agent) (may be null)"},"agent_name":{"type":"string","description":"User agent name (if grouped by agent) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by collection for agents endpoint"},"TrafficReportsTotalCollectionsOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by collection for organizations endpoint"},"TrafficReportsTotalCollectionsOrganizationsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"organization_id":{"type":"integer","description":"Organization ID (if grouped by organization) (may be null)"},"organization_name":{"type":"string","description":"Organization name (if grouped by organization) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by collection for organizations endpoint"},"TrafficReportsTotalCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by collection for networks endpoint"},"TrafficReportsTotalCollectionsUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"List of user IDs that are contained in the response"},"user_names":{"type":"array","items":{"type":"string"},"description":"User names"},"user_logins":{"type":"array","items":{"type":"string"},"description":"User logins"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalCollectionsUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by collection for users endpoint"},"TrafficReportsTotalCollectionsUsersResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID"},"collection_name":{"type":"string","description":"Collection name"},"user_id":{"type":"integer","description":"User ID (if grouped by user) (may be null)"},"user_name":{"type":"string","description":"User name or friendly name (if grouped by user) (may be null)"},"user_login":{"type":"string","description":"User remote login (if grouped by user) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by collection for users endpoint"},"TrafficReportsTotalDeployments":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID"},"organization_name":{"type":"string","description":"Organization name"},"collections":{"type":"integer","description":"Number of collections"},"user_agents":{"type":"integer","description":"Number of user agents"},"sync_tools":{"type":"integer","description":"Number of sync tools"},"relays":{"type":"integer","description":"Number of relays"},"users":{"type":"integer","description":"Number of users from an organization"}},"description":"Traffic reports top deployments endpoint"},"TrafficReportsTotalDomainRequests":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainRequestsResult"},"description":"Result data of the report"}},"description":"Traffic reports total number of requests for a domain in a period of time"},"TrafficReportsTotalDomainRequestsResult":{"type":"object","properties":{"bucket":{"type":"string","description":"Bucket datetime in UTC"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"},"threat_requests":{"type":"integer","description":"Number of threat requests in the bucket"}},"description":"Traffic reports total number of requests for a domain in a period of time"},"TrafficReportsTotalDomainStats":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"},"threat_requests":{"type":"integer","description":"Number of threat requests in the bucket"}},"description":"Traffic reports total number of stats for a domain in a period of time"},"TrafficReportsTotalDomains":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by domain for networks endpoint"},"TrafficReportsTotalDomainsAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by domain for agents endpoint"},"TrafficReportsTotalDomainsAgentsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID (if grouped by agent) (may be null)"},"agent_type":{"type":"string","description":"User agent type (if grouped by agent) (may be null)"},"agent_name":{"type":"string","description":"User agent name (if grouped by agent) (may be null)"},"domain":{"type":"string","description":"Domain"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by domain for agents endpoint"},"TrafficReportsTotalDomainsCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by domain for collections endpoint"},"TrafficReportsTotalDomainsCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID (if grouped by collection) (may be null)"},"collection_name":{"type":"string","description":"Collection name (if grouped by collection) (may be null)"},"domain":{"type":"string","description":"Domain"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by domain for collections endpoint"},"TrafficReportsTotalDomainsOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by domain for organizations endpoint"},"TrafficReportsTotalDomainsOrganizationsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID (if grouped by organization) (may be null)"},"organization_name":{"type":"string","description":"Organization name (if grouped by organization) (may be null)"},"domain":{"type":"string","description":"Domain"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by domain for organizations endpoint"},"TrafficReportsTotalDomainsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"domain":{"type":"string","description":"Domain"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by domain for networks endpoint"},"TrafficReportsTotalDomainsUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"List of user IDs that are contained in the response"},"user_names":{"type":"array","items":{"type":"string"},"description":"User names"},"user_logins":{"type":"array","items":{"type":"string"},"description":"User logins"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalDomainsUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests by domain for users endpoint"},"TrafficReportsTotalDomainsUsersResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID (if grouped by user) (may be null)"},"user_name":{"type":"string","description":"User name or friendly name (if grouped by user) (may be null)"},"user_login":{"type":"string","description":"User remote login (if grouped by user) (may be null)"},"domain":{"type":"string","description":"Domain"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests by domain for users endpoint"},"TrafficReportsTotalOrganizationsNetworkRequests":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalOrganizationsNetworkRequestsResult"},"description":"Result data of the report"}},"description":"Traffic reports total number of requests for organizations in a period of time"},"TrafficReportsTotalOrganizationsNetworkRequestsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Network ID"},"network_name":{"type":"string","description":"Network Name"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"}}},"TrafficReportsTotalOrganizationsRequests":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalOrganizationsRequestsResult"},"description":"Result data of the report"}},"description":"Traffic reports total number of requests for organizations in a period of time"},"TrafficReportsTotalOrganizationsRequestsResult":{"type":"object","properties":{"bucket":{"type":"string","description":"Bucket datetime in UTC"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"},"threat_requests":{"type":"integer","description":"Number of threat requests in the bucket"}},"description":"Traffic reports total number of requests for organizations in a period of time"},"TrafficReportsTotalOrganizationsStats":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"total_requests":{"type":"integer","description":"Number of total requests in the bucket"},"allowed_requests":{"type":"integer","description":"Number of allowed requests in the bucket"},"blocked_requests":{"type":"integer","description":"Number of blocked requests in the bucket"},"threat_requests":{"type":"integer","description":"Number of threat requests in the bucket"}},"description":"Traffic reports total number of stats for organizations in a period of time"},"TrafficReportsTotalRequests":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for networks endpoint"},"TrafficReportsTotalRequestsAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for agents endpoint"},"TrafficReportsTotalRequestsAgentsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID (if grouped by agent) (may be null)"},"agent_type":{"type":"string","description":"User agent type (if grouped by agent) (may be null)"},"agent_name":{"type":"string","description":"User agent name (if grouped by agent) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests for agents endpoint"},"TrafficReportsTotalRequestsCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for collections endpoint"},"TrafficReportsTotalRequestsCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID (if grouped by collection) (may be null)"},"collection_name":{"type":"string","description":"Collection name (if grouped by collection) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests for collections endpoint"},"TrafficReportsTotalRequestsGeo":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"string"},"description":"Network IDs that are contained in the response"},"network_names":{"type":"array","items":{"type":"string"},"description":"Network names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsGeoResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for geo endpoint"},"TrafficReportsTotalRequestsGeoResult":{"type":"object","properties":{"network_id":{"type":"integer"},"total_requests":{"type":"integer"},"qps":{"type":"integer"}},"description":"Traffic reports total requests for geo endpoint"},"TrafficReportsTotalRequestsOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for organizations endpoint"},"TrafficReportsTotalRequestsOrganizationsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID (if grouped by organization) (may be null)"},"organization_name":{"type":"string","description":"Organization name (if grouped by organization) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests for organizations endpoint"},"TrafficReportsTotalRequestsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests for networks endpoint"},"TrafficReportsTotalRequestsUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRequestsUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports total requests for users endpoint"},"TrafficReportsTotalRequestsUsersResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID (if grouped by user) (may be null)"},"user_name":{"type":"string","description":"User name or friendly name (if grouped by user) (may be null)"},"user_login":{"type":"string","description":"User remote login (if grouped by user) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total requests for users endpoint"},"TrafficReportsTotalRoamingClients":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalRoamingClientsResult"},"description":"Result data of the report"}},"description":"Traffic reports total roaming clients information"},"TrafficReportsTotalRoamingClientsResult":{"type":"object","properties":{"os":{"type":"string","description":"deployment OS name"},"value":{"type":"integer","description":"Number of deployments"}},"description":"Traffic reports total roaming clients information per organization networks"},"TrafficReportsTotalThreats":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of network IDs that are contained in the response (if grouped by network ID)"},"network_names":{"type":"array","items":{"type":"string"},"description":"Networks names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsResult"},"description":"Result data of the report"}},"description":"Traffic reports total threats for networks endpoint"},"TrafficReportsTotalThreatsAgents":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of user agents that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsAgentsResult"},"description":"Result data of the report"}},"description":"Traffic reports total threats for agents endpoint"},"TrafficReportsTotalThreatsAgentsResult":{"type":"object","properties":{"agent_id":{"type":"string","description":"User agent UUID (if grouped by agent) (may be null)"},"agent_type":{"type":"string","description":"User agent type (if grouped by agent) (may be null)"},"agent_name":{"type":"string","description":"User agent name (if grouped by agent) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total threats for agents endpoint"},"TrafficReportsTotalThreatsCollections":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"collection_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of collection IDs that are contained in the response"},"collection_names":{"type":"array","items":{"type":"string"},"description":"Collections names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsCollectionsResult"},"description":"Result data of the report"}},"description":"Traffic reports total threats for collections endpoint"},"TrafficReportsTotalThreatsCollectionsResult":{"type":"object","properties":{"collection_id":{"type":"integer","description":"Collection ID (if grouped by collection) (may be null)"},"collection_name":{"type":"string","description":"Collection name (if grouped by collection) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total threats for collections endpoint"},"TrafficReportsTotalThreatsOrganizations":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"agent_ids":{"type":"array","items":{"type":"string"},"description":"UUID list of network IDs that are contained in the response (if grouped by user agent ID)"},"agent_names":{"type":"array","items":{"type":"string"},"description":"User agents names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsOrganizationsResult"},"description":"Result data of the report"}},"description":"Traffic reports total threats for organizations endpoint"},"TrafficReportsTotalThreatsOrganizationsResult":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID (if grouped by organization) (may be null)"},"organization_name":{"type":"string","description":"Organization name (if grouped by organization) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total threats for organizations endpoint"},"TrafficReportsTotalThreatsResult":{"type":"object","properties":{"network_id":{"type":"integer","description":"Bucket network ID (if grouped by network ID) (may be null)"},"network_name":{"type":"string","description":"Network name (if grouped by network ID) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"policies":{"type":"array","items":{"type":"integer"},"description":"Matched policies IDs for the domain"},"policies_names":{"type":"array","items":{"type":"string"},"description":"Matched policies IDs names"},"scheduled_policies":{"type":"array","items":{"type":"integer"},"description":"Matched scheduled policies IDs for the domain"},"scheduled_policies_names":{"type":"array","items":{"type":"string"},"description":"Matched scheduled policies IDs names"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total threats for networks endpoint"},"TrafficReportsTotalThreatsUsers":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Integer list of organization IDs that are contained in the response"},"organization_names":{"type":"array","items":{"type":"string"},"description":"Organizations names"},"values":{"type":"array","items":{"$ref":"#/components/schemas/TrafficReportsTotalThreatsUsersResult"},"description":"Result data of the report"}},"description":"Traffic reports total threats for users endpoint"},"TrafficReportsTotalThreatsUsersResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID (if grouped by user) (may be null)"},"user_name":{"type":"string","description":"User name or friendly name (if grouped by user) (may be null)"},"user_login":{"type":"string","description":"User remote login (if grouped by user) (may be null)"},"bucket":{"type":"string","description":"Bucket datetime in UTC"},"total":{"type":"integer","description":"Number of total requests in the bucket"},"total_networks":{"type":"integer","description":"Number of total requests in the bucket made by networks only"},"total_proxies":{"type":"integer","description":"Number of total requests in the bucket made by LAN proxies only"},"total_agents":{"type":"integer","description":"Number of total requests in the bucket made by user agents only"}},"description":"Traffic reports total threats for users endpoint"},"TrialCreate":{"type":"object","properties":{"organization_id":{"type":"integer"},"sku":{"type":"string"}},"description":"Trial resource"},"TrialSpec":{"type":"object","properties":{"entitlement_key":{"type":"string"},"entitlement_name":{"type":"string"},"skus":{"type":"array","items":{"type":"string"}},"addon":{"type":"string"},"addon_sku":{"type":"string"},"in_use":{"type":"boolean"},"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"},"grace_period":{"type":"string","format":"date"},"active":{"type":"boolean"}},"description":"Trial details"},"UnblockRequestIndexSpec":{"type":"object","properties":{"id":{"type":"string","description":"Unblock request UUID."},"attributes":{"$ref":"#/components/schemas/UnblockRequestAttributesSpec"}},"description":"A single unblock request row for the Active Requests / Request History grids."},"UnblockRequestAttributesSpec":{"type":"object","properties":{"domain":{"type":"string","description":"Requested domain."},"organization":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"site":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"policy":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"category":{"$ref":"#/components/schemas/UnblockRequestCategorySpec"},"time_of_attempt":{"type":"string","description":"ISO 8601 timestamp of when the request was made."},"logged_in_user":{"type":"string","description":"Name of the logged-in device user, if known (may be null)."},"email":{"type":"string","description":"Requester email address."},"request_reason":{"type":"string","description":"Free-text reason supplied by the requester."},"actioned_by":{"$ref":"#/components/schemas/UnblockRequestActionerSpec"},"resolved_date":{"type":"string","description":"History only: ISO 8601 timestamp of when the request was decided (may be null for a not-yet-swept expired row)."},"action":{"type":"string","enum":["allowed","denied","ignored","resolved_already_allowed","expired"],"description":"History only: the decision. A pending row past its expiry window reports \"expired\"."}},"description":"Unblock request grid columns. The last three (actioned_by, resolved_date,\naction) are present only on the Request History tab (tab=history)."},"UnblockRequestLinkedResourceSpec":{"type":"object","properties":{"id":{"type":"integer","description":"Resource ID (may be null if the reference has decayed)."},"name":{"type":"string","description":"Resource display name (may be null)."}},"description":"A linkable {id, name} reference (organization, site, or policy)."},"UnblockRequestCategorySpec":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"Category IDs the domain was blocked under."},"names":{"type":"array","items":{"type":"string"},"description":"Category display names, aligned by index with ids."},"is_threat":{"type":"boolean","description":"True if any category is a DNSFilter threat category."}},"description":"Category payload for a request. `names` is positionally aligned with `ids`\n(an entry may be null where a category has since been deleted). `is_threat`\nlets the grid apply threat styling without a second lookup."},"UnblockRequestActionerSpec":{"type":"object","properties":{"id":{"type":"integer","description":"User ID."},"name":{"type":"string","description":"User display name."},"email":{"type":"string","description":"User email address."}},"description":"The admin who actioned a request (Request History \"Actioned by\")."},"UnblockRequestsMetaSpec":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of matching requests."},"total_pages":{"type":"integer","description":"Total number of pages."},"current_page":{"type":"integer","description":"Current page number."}},"description":"Pagination metadata for the unblock requests list."},"UnblockRequestShowSpec":{"type":"object","properties":{"id":{"type":"string","description":"Unblock request UUID."},"attributes":{"$ref":"#/components/schemas/UnblockRequestShowAttributesSpec"}},"description":"A single unblock request with everything the Approve/Deny action drawer needs."},"UnblockRequestShowAttributesSpec":{"type":"object","properties":{"domain":{"type":"string","description":"Requested domain."},"requester_name":{"type":"string","description":"Name supplied by the requester."},"requester_email":{"type":"string","description":"Email supplied by the requester."},"request_reason":{"type":"string","description":"Free-text reason supplied by the requester."},"organization":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"site":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"policy":{"$ref":"#/components/schemas/UnblockRequestLinkedResourceSpec"},"logged_in_user":{"type":"string","description":"Name of the logged-in device user, if known (may be null)."},"category":{"$ref":"#/components/schemas/UnblockRequestCategorySpec"},"time_of_attempt":{"type":"string","description":"ISO 8601 timestamp of when the request was made."},"already_covered":{"$ref":"#/components/schemas/UnblockRequestCoverageSpec"},"allow_list_targets":{"type":"array","items":{"$ref":"#/components/schemas/UnblockRequestAllowListTargetSpec"},"description":"The lists the admin can add the domain to."}},"description":"Action-drawer payload for one unblock request."},"UnblockRequestCoverageSpec":{"type":"object","properties":{"covered":{"type":"boolean","description":"True if the domain is already on one of the checked lists."},"list":{"type":"string","enum":["policy","universal_org","universal_msp"],"description":"Which list covers it (null when not covered)."},"date_added":{"type":"string","description":"Coarse list-level ISO 8601 timestamp the list was last updated (arrays carry no per-entry date; null when not covered)."}},"description":"Whether the domain is already covered by an allow list, evaluated at call time."},"UnblockRequestAllowListTargetSpec":{"type":"object","properties":{"type":{"type":"string","enum":["policy","universal"],"description":"Target kind."},"id":{"type":"integer","description":"Policy ID (policy target only; absent for universal)."},"name":{"type":"string","description":"Target display name."},"affects_all":{"type":"boolean","description":"Universal target only: it affects all sites and users."},"blast_radius":{"$ref":"#/components/schemas/UnblockRequestBlastRadiusSpec"},"already_on_list":{"type":"boolean","description":"True if the domain is already on this specific target."},"date_added":{"type":"string","description":"Coarse list-level ISO 8601 timestamp when already_on_list (else null)."}},"description":"An allow list the admin can add the domain to, with its blast radius and current coverage."},"UnblockRequestBlastRadiusSpec":{"type":"object","properties":{"sites":{"type":"integer","description":"Number of sites affected."},"users":{"type":"integer","description":"Number of users affected."}},"description":"Reach of an allow-list target."},"UnblockRequestDecisionRequestSpec":{"type":"object","properties":{"decision":{"type":"string","enum":["allow","allow-universal","deny","deny-and-ignore","resolve-already-allowed"],"description":"The action to apply."},"domains":{"type":"array","items":{"type":"string"},"description":"Allow / Allow-Universal only: the apex domain plus any frontend-resolved CNAME hosts to add to the allow list. Defaults to the request's own domain when omitted."},"message":{"type":"string","description":"Deny only: optional Message to Requester (max 500 characters)."}},"required":["decision"],"description":"Body for actioning a pending unblock request (POST .../decision). `domains`\napplies only to the Allow variants; `message` only to Deny — both are ignored\nfor the other decisions."},"UnblockRequestDecisionSpec":{"type":"object","properties":{"id":{"type":"string","description":"Unblock request UUID."},"attributes":{"$ref":"#/components/schemas/UnblockRequestDecisionAttributesSpec"}},"description":"The just-decided request — lean enough for the grid to refresh the row in\nplace. Unlike the drawer (show) payload it carries no blast-radius or coverage\ndata: the decision is already made, so that context is irrelevant."},"UnblockRequestDecisionAttributesSpec":{"type":"object","properties":{"domain":{"type":"string","description":"Requested domain."},"status":{"type":"string","enum":["allowed","denied","ignored","resolved_already_allowed","expired"],"description":"Terminal status after the decision. An Allow whose domain was already covered resolves as resolved_already_allowed; a row past its expiry window reports expired."},"decided_at":{"type":"string","description":"ISO 8601 timestamp of when the decision was made (may be null for a not-yet-swept expired row)."},"decided_by":{"$ref":"#/components/schemas/UnblockRequestActionerSpec"},"response_message":{"type":"string","description":"The optional Message to Requester recorded on Deny (null otherwise)."}},"description":"Result of an admin decision on an unblock request."},"UnblockRequestsCsvExportSpec":{"type":"object","properties":{"uuid":{"type":"string","description":"format:uuidv7 Export UUID."},"tab":{"type":"string","enum":["active","history"],"description":"Which grid was exported."},"row_count":{"type":"integer","description":"Number of rows in the export (the snapshot size; capped at 10,000)."},"total_count":{"type":"integer","description":"Total rows in the filtered view. Exceeds row_count when the cap truncated the export."},"truncated":{"type":"boolean","description":"True when the filtered view exceeded the row cap and was clipped."},"url":{"type":"string","description":"Presigned S3 URL to download the CSV (null while still processing or if the build failed)."},"error":{"type":"string","description":"Error message if the export failed (null otherwise)."}},"description":"Unblock requests CSV export tracking record. Returned by create and by show once\nthe build has finished (url present) or failed (error present)."},"UnblockRequestsCsvExportPendingSpec":{"type":"object","properties":{"uuid":{"type":"string","description":"format:uuidv7 Export UUID."},"status":{"type":"string","enum":["processing"],"description":"Indicates the export is still processing."}},"description":"Poll payload returned by show (HTTP 202) while the export is still building."},"UnblockRequestsCsvExportCreateSpec":{"type":"object","properties":{"unblock_requests_csv_export":{"type":"object","properties":{"included_columns":{"type":"array","items":{"type":"string"}}},"description":"Optional. included_columns: ordered column keys to include (empty/omitted = the tab's full default set in documented order; unknown keys ignored; history-only keys dropped on the Active tab)."}},"description":"Optional request body for creating an export. Tab, search, sort, the per-column\nfilters and org/MSP scope are all sent as query parameters (identical to the grid);\nonly the column selection is nested in the body."},"UrlFilterLogSpec":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp"},"organization":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"description":"Organization"},"network":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"description":"Network"},"fqdn":{"type":"string","description":"FQDN"},"reason":{"type":"string","description":"Reason for decision. Possible responses: AppAware, Category, or Rule"},"rule":{"type":"string","description":"Rule"},"rule_id":{"type":"integer","description":"Rule ID"},"allowed":{"type":"boolean","description":"True if allowed, false otherwise"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"description":"List of categories"},"user_agent":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"description":"User agent"},"agent_local_user":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"description":"Agent local user"},"url_path":{"type":"string","description":"URL path, included for users with necessary permissions"}},"description":"Url filter log resource"},"UrlFilterLogPagination":{"type":"object","properties":{"size":{"type":"integer","description":"Number of rows per page"},"first":{"type":"integer","description":"Number of the first page"},"self":{"type":"integer","description":"Number of the current page"},"prev":{"type":"integer","description":"Number of the previous page (if any) (may be null)"},"next":{"type":"integer","description":"Number of the next page (if any) (may be null)"}},"description":"Url filter log pagination response"},"UrlFilterWithoutCategories":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"},"type":{"type":"string","description":"The type: url or pattern"}},"description":"Url filter resource"},"UrlFilter":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"},"type":{"type":"string","description":"The type: url or pattern"},"applications":{"type":"array","items":{"type":"string"},"description":"List of applications if requested"},"categories":{"type":"array","items":{"type":"string"},"description":"List of categories if requested"}},"description":"Url filter resource"},"UrlFilterCreateUrl":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"}},"description":"Url filter resource"},"AllowedUrlFilterCreate":{"type":"object","properties":{"policy_id":{"type":"integer","description":"The policy id"},"allowed_urls":{"type":"array","items":{"$ref":"#/components/schemas/UrlFilterCreateUrl"},"description":"A list of urls to create"}},"description":"Url filter resource"},"BlockedUrlFilterCreate":{"type":"object","properties":{"policy_id":{"type":"integer","description":"The policy id"},"blocked_urls":{"type":"array","items":{"$ref":"#/components/schemas/UrlFilterCreateUrl"},"description":"A list of urls to create"}},"description":"Url filter resource"},"UrlFilterUpdateUrl":{"type":"object","properties":{"value":{"type":"string","description":"Value"},"note":{"type":"string","description":"Note"},"policy_id":{"type":"integer","description":"The policy id"}},"description":"Url filter resource"},"UrlFilterDestroyUrl":{"type":"object","properties":{"policy_id":{"type":"integer","description":"The policy id"}},"description":"Url filter resource"},"UrlFilterBulkUpdate":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to update. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to remove from update when using filters"},"changeset":{"$ref":"#/components/schemas/UrlFilterBulkUpdateChangeset"}},"description":"Url filter bulk update resource"},"UrlFilterBulkDelete":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to delete. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to remove from delete when using filters"}},"description":"Url filter bulk delete resource"},"UrlFilterBulkUpdateChangeset":{"type":"object","properties":{"note":{"type":"string"}},"description":"Url filter bulk update changeset"},"AllowedUrlSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/UrlFilter"}}}],"description":"Allowed url specification"},"BlockedUrlSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/UrlFilter"}}}],"description":"Blocked url specification"},"UrlFilterHasMixedBody":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to check. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to check when using filters"}},"description":"Url filter has mixed resource"},"UrlFilterHasMixedResponse":{"type":"object","properties":{"mixed":{"type":"boolean","description":"Selected urls have different notes"}},"description":"Url filter has mixed response"},"UrlFilterCountBody":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to count. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of url filters to count when using filters"}},"description":"Url filter count resource"},"UrlFilterCountResponse":{"type":"object","properties":{"count":{"type":"integer","description":"Total amount of urls in table"}},"description":"Url filter table count"},"UrlFilterTestResponse":{"type":"object","properties":{"url":{"type":"string","description":"The test url"},"evaluation":{"type":"string","description":"the evaluation response: \"allowed\" or \"blocked\""},"blocked_urls":{"type":"array","items":{"$ref":"#/components/schemas/UrlFilterWithoutCategories"},"description":"block urls that matched test url"},"allowed_urls":{"type":"array","items":{"$ref":"#/components/schemas/UrlFilterWithoutCategories"},"description":"allow urls that matched test url"},"content_categories":{"type":"array","items":{"type":"string"},"description":"categories for test url"},"threat_categories":{"type":"array","items":{"type":"string"},"description":"categories for test url"},"applications":{"type":"array","items":{"type":"string"},"description":"applications for test url"}},"description":"Url filter test response"},"UserAgentRelease":{"type":"object","properties":{"agent_type":{"type":"string","enum":["windows","macos"],"description":"Agent type"},"architecture":{"type":"string","enum":["x86","x86_64"],"description":"Architecture for the release"},"agent_version":{"type":"string","description":"A version number in semver format"},"white_label":{"type":"boolean","description":"true if white label release, false otherwise"},"release_channels":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"visible":{"type":"boolean"}}},"description":"An array of objects with values including \"stable\" or \"beta\", and corresponding labels"},"url":{"type":"string","description":"The location of the release"}},"description":"User agent release resource"},"UserAgent":{"type":"object","properties":{"agent_type":{"type":"string","enum":["proxy","windows","macos","linux","android","ios","embedded","dnsmasq","fingbox"],"description":"Agent type"},"agent_version":{"type":"string","description":"Agent current version"},"client_id":{"type":"string","description":"Client generated GUID"},"hostname":{"type":"string","description":"Hostname"},"status":{"type":"string","enum":["active","disabled","uninstalled","uninstalled_from_client","created"],"description":"Agent status"},"os_version":{"type":"string","description":"Host OS version (may be null)"},"os_name":{"type":"string","description":"Host OS name (may be null)"},"friendly_name":{"type":"string","description":"Agent friendly name (may be null)"},"tags":{"type":"array","items":{"type":"string"},"description":"Agent tags (may be null)"},"meta":{"type":"string","description":"Agent meta data (JSON) (may be null)"},"created_at":{"type":"string","format":"date","description":"Creation date"},"updated_at":{"type":"string","format":"date","description":"Last update"},"uninstalled_at":{"type":"string","format":"date","description":"Date when the agent was uninstalled from the machine (may be null)"},"id_hex":{"type":"string","description":"Agent UUID in hex representation"},"id_binary":{"type":"array","items":{"type":"integer"},"description":"Agent UUID in binary representation"},"last_sync":{"type":"string","format":"date","description":"Last sync API received from user agent"},"agent_state":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"],"description":"Agent state"},"cyber_sight_client":{"type":"object","properties":{"service_state":{"type":"string","enum":["not_installed","operational","disabled","error"]},"chrome_extension_status":{"type":"string","enum":["not_installed","operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"]},"edge_extension_status":{"type":"string","enum":["not_installed","operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"]}},"description":"Cyber sight client information"},"cyber_sight_client_setting":{"type":"object","properties":{"enable_browser_extension":{"type":"boolean"}},"description":"Cyber sight client settings"},"device_setting":{"type":"object","properties":{"auto_updates":{"type":"boolean"},"enable_cyber_sight":{"type":"boolean"}},"description":"Device settings"},"filtering_client_setting":{"$ref":"#/components/schemas/UserAgentFilteringClientSetting"}},"description":"User agent resource"},"UserAgentFilteringClientSetting":{"type":"object","properties":{"auto_updates":{"type":"boolean","description":"Auto updates setting"},"connection_method":{"type":"string","enum":["inherit","transparent_prox","loopback"],"description":"Configures connection type"},"filtering_method":{"type":"string","enum":["inherit","precheck","dns_filtering"],"description":"Configures filtering mode"},"fail_over_method":{"type":"string","enum":["inherit","fail_open","fail_close"],"description":"Configures fail over method"}},"description":"User agent filtering client setting"},"UserAgentSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/UserAgent"},"relationships":{"type":"object","properties":{"network":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}},"scheduled_policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IdType"}}}},"description":"] User agent associated objects"}}}],"description":"User agent specification"},"UserAgentCount":{"type":"object","properties":{"count":{"type":"integer","description":"Total user agents based on filters"}},"description":"User agents count"},"UserAgentCreate":{"type":"object","properties":{"agent_type":{"type":"string","enum":["proxy","windows","macos","linux","android","ios","embedded"],"description":"Agent type"},"agent_version":{"type":"string","description":"Agent version"},"client_id":{"type":"string","description":"Client generated GUID"},"hostname":{"type":"string","description":"Hostname"},"os_version":{"type":"string","description":"Host OS version (may be null)"},"os_name":{"type":"string","description":"Host OS name (may be null)"},"white_label":{"type":"boolean","description":"White label or branded"},"release_channel":{"type":"string","description":"Active release channel"},"meta":{"type":"string","description":"Agent meta data (JSON) (may be null)"},"user_agent_hardware_identifiers_attributes":{"type":"array","items":{"$ref":"#/components/schemas/UserAgentHardwareIdentifierAttributes"},"description":"Hardware identifiers for machine deduplication"}},"description":"User agent creation request parameters"},"UserAgentHardwareIdentifierAttributes":{"type":"object","properties":{"version":{"type":"integer","description":"Hardware identifier version"},"value":{"type":"string","description":"Hardware identifier value"}},"required":["version","value"],"description":"Hardware identifier used to deduplicate user agents across registrations"},"UserAgentCreateSpec":{"type":"object","properties":{"secret_key":{"type":"string","description":"Network secret key"},"id":{"type":"string","description":"User agent id is re-registering"},"user_agent":{"$ref":"#/components/schemas/UserAgentCreate"}},"required":["secret_key","user_agent"],"description":"User agent creation request parameters"},"UserAgentPatch":{"type":"object","properties":{"friendly_name":{"type":"string","description":"Agent friendly name"},"status":{"type":"string","enum":["active","disabled","uninstalled"],"description":"Agent status"},"network_id":{"type":"integer","description":"User agent network/site ID, useful to change user agent between networks/sites"},"policy_id":{"type":"integer","description":"Agent custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set"},"scheduled_policy_id":{"type":"integer","description":"Agent custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"Agent custom block page ID"},"tags":{"type":"array","items":{"type":"string"},"description":"Agent tags"},"vpn_settings_user_agent_attributes":{"$ref":"#/components/schemas/VpnSettingsUserAgentAttributes"}},"description":"User agent creation request parameters"},"UserAgentPatchSpec":{"type":"object","properties":{"user_agent":{"$ref":"#/components/schemas/UserAgentPatch"}},"required":["user_agent"],"description":"User agent update request parameters"},"UserAgentSync":{"allOf":[{"$ref":"#/components/schemas/UserAgentCreate"},{"type":"object","properties":{"current_user_uuid":{"type":"string","description":"Agent current logged in user UUID"},"current_user_login":{"type":"string","description":"Agent current logged in user login"},"current_user_name":{"type":"string","description":"Agent current logged in user name"}}}],"description":"User agent creation request parameters"},"UserAgentAdvancedFilteringSync":{"type":"object","properties":{"filter_status":{"type":"integer","description":"Advanced filtering status"},"filter_status_code":{"type":"integer","description":"Advanced filtering status code"},"filter_status_message":{"type":"string","description":"Advanced filtering status message"},"extension_version":{"type":"string","description":"Advanced filtering extension version"}},"description":"User agent advanced filtering parameters"},"UserAgentSyncSpec":{"type":"object","properties":{"user_agent":{"$ref":"#/components/schemas/UserAgentSync"},"advanced_filtering_status":{"$ref":"#/components/schemas/UserAgentAdvancedFilteringSync"}},"required":["user_agent"],"description":"User agent sync request parameters"},"UserAgentLookup":{"allOf":[{"$ref":"#/components/schemas/NetworkLookup"},{"type":"object","properties":{"block_source":{"type":"string","enum":["network","agent","proxy","subnet"],"description":"Block page source"}}}],"description":"User agent lookup response"},"LegacyUserAgentCounts":{"type":"object","properties":{"all":{"type":"integer","description":"the count of all user agents"},"protected":{"type":"integer","description":"the count of protected user agents"},"unprotected":{"type":"integer","description":"the count of unprotected user agents"},"bypassed":{"type":"integer","description":"the count of bypassed user agents"},"pending_uninstall":{"type":"integer","description":"the count of pending uninstall agents"},"uninstalled":{"type":"integer","description":"the count of uninstalled user agents"}},"description":"User agent counts by state"},"UserAgentCounts":{"type":"object","properties":{"all":{"type":"integer","description":"the count of all user agents"},"protected":{"type":"integer","description":"the count of protected user agents"},"unprotected":{"type":"integer","description":"the count of unprotected user agents"},"offline":{"type":"integer","description":"the count of offline user agents"}},"description":"User agent counts by state"},"UserAgentCleanup":{"type":"object","properties":{"inactive_for":{"type":"integer","description":"the number of inactive days for user agent to be included in cleanup"},"organization_id":{"type":"integer","description":"Organization resource ID - deprecated"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization resource IDs"},"query_completed":{"type":"boolean","description":"true if query to find inactive agents completed"},"started":{"type":"boolean","description":"true if cleanup process started"},"completed":{"type":"boolean","description":"true if cleanup process completed"},"to_delete":{"type":"array","items":{"type":"string"},"description":"name of agents to be deleted"},"agents_to_delete":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organization_name":{"type":"string"}}},"description":"agents to be deleted"}},"description":"User agent cleanups"},"UserAgentCleanupCreate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization ID - deprecated"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"List of Organization IDs"},"inactive_for":{"type":"integer","description":"The number of inactive days"}},"required":["organization_ids","inactive_for"],"description":"User agent cleanup create"},"UserAgentCleanupUpdate":{"type":"object","properties":{"start":{"type":"boolean","description":"Start the cleanup, will do nothing if inactive_for is included"},"inactive_for":{"type":"integer","description":"The number of inactive days, updating restarts job to find RCs to delete"}},"description":"User agent cleanup update"},"UserAgentBulkUpdate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization resource ID"},"completed":{"type":"boolean","description":"true if bulk update is completed"},"count":{"type":"integer","description":"count of affected user agents"}},"description":"User agent bulk update"},"UserAgentBulkUpdateCreate":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of user agents to update. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of user agents to remove from update when using filters"},"changeset":{"$ref":"#/components/schemas/UserAgentBulkUpdateCreateChangeset"}},"description":"User agent bulk update"},"UserAgentBulkUpdateCreateChangeset":{"type":"object","properties":{"network_id":{"type":"integer","description":"User agent network/site ID, useful to change user agent between networks/sites"},"policy_id":{"type":"integer","description":"Agent custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set"},"scheduled_policy_id":{"type":"integer","description":"Agent custom scheduled policy ID"},"block_page_id":{"type":"integer","description":"Agent custom block page ID"},"friendly_name":{"type":"string","description":"Agent friendly name (may be null)"},"tags":{"type":"array","items":{"type":"string"},"description":"Agent tags"},"release_channels":{"type":"array","items":{"type":"string"},"description":"Release channel"},"device_setting_attributes":{"$ref":"#/components/schemas/DeviceSettingBulkAttributes"},"filtering_client_setting_attributes":{"$ref":"#/components/schemas/FilteringClientSettingBulkAttributes"},"vpn_settings_user_agent":{"$ref":"#/components/schemas/VpnSettingsUserAgentAttributes"}},"description":"User agent bulk update changeset"},"UserAgentBulkUpdateHasMixed":{"type":"object","properties":{"siteMixed":{"type":"boolean","description":"true if sites are mixed"},"tagsMixed":{"type":"boolean","description":"true if tags are mixed"},"policyMixed":{"type":"boolean","description":"true if policies are mixed"},"blockPageMixed":{"type":"boolean","description":"true if blockPages are mixed"}},"description":"User agents bulk mixed attribute check"},"UserAgentBulkUpdateHasMixedRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of user agents to use in the"}},"description":"User agents bulk ids"},"UserAgentBulkDelete":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization resource ID"},"completed":{"type":"boolean","description":"true if bulk delete is completed"},"count":{"type":"integer","description":"count of affected user agents"},"queue_uninstall":{"type":"boolean","description":"true if action was bulk delete and uninstall"}},"description":"User agent bulk delete"},"UserAgentBulkDeleteCreate":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Ids of user agents to delete. Overrides any lookups based on filters"},"exclude_ids":{"type":"array","items":{"type":"string"},"description":"Ids of user agents to remove from delete when using filters"}},"description":"User agent bulk delete"},"UserAgentBulkDeleteCounts":{"type":"object","properties":{"uninstall_and_delete":{"type":"integer","description":"the count of user agents that can bed uninstalled and deleted"},"delete":{"type":"integer","description":"the count of unsupported user agents that can be deleted"}},"description":"User agent counts by remote uninstall support"},"UserAgentAfProxyBlockPageEmail":{"type":"object","properties":{"id":{"type":"string","description":"User agent ID"},"user_agent":{"type":"string","description":"User Agent info"},"ip_address":{"type":"string","description":"IP address"},"blocked_domain":{"type":"string","description":"Blocked domain"},"policy_id":{"type":"integer","description":"Policy ID"},"category_name":{"type":"string","description":"Category name"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User name"},"phone":{"type":"string","description":"User phone"},"message":{"type":"string","description":"Message"}},"required":["id","policy_id"],"description":"Blocked email request parameters"},"UserAgentCsvExport":{"type":"object","properties":{"id":{"type":"integer","description":"User agent csv export ID"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":"Organization IDs"},"url":{"type":"string","description":"URL to download the CSV"},"error":{"type":"string","description":"Error message if export failed"}},"description":"User agent csv export"},"UserAgentCsvExportCreate":{"type":"object","properties":{"user_agent_csv_export":{"type":"object","properties":{"organization_ids":{"type":"array","items":{"type":"integer"}},"msp_id":{"type":"integer"},"ids":{"type":"array","items":{"type":"string"}}},"description":"CSV export attributes"},"network_ids":{"type":"array","items":{"type":"integer"},"description":"Networks IDs, defaults to all"},"type":{"type":"string","enum":["proxy","agents"],"description":"User agent type, defaults to non-proxy/no-relays user agents"},"search":{"type":"string","description":"User agent list by keyword(s) (space delimited), this could be: hostname, friendly name"},"name_search":{"type":"string","description":"A search term to search client name fields (i.e. hostname and friendly_name)"},"tags":{"type":"array","items":{"type":"string"},"description":"User agent list by tags"},"status":{"type":"string","description":"filter by user agent status, valid attributes: active, disabled, uninstalled"},"state":{"type":"string","enum":["online","offline"],"description":"filter by user agent online/offline state"},"agent_state":{"type":"string","enum":["protected","unprotected","bypassed","uninstalled"],"description":"filter by agent state"},"traffic_received_last_15_mins":{"type":"boolean","description":"filter by agents that have received traffic in last 15 minutes"}},"description":"User agent csv export"},"UserAgentDoh":{"type":"object","properties":{"hashed_device_sn":{"type":"string","description":"Device serial number/identifier (hashed)"},"hashed_user_email":{"type":"string","description":"End user email (hashed)"},"secret_key":{"type":"string","description":"Network secret key"},"user_agent":{"$ref":"#/components/schemas/UserAgentDohCreate"}},"required":["hashed_device_sn","secret_key"],"description":"Doh lua request"},"UserAgentDohCreate":{"type":"object","properties":{"agent_type":{"type":"string","enum":["proxy","windows","macos","linux","android","ios","embedded"],"description":"Agent type"},"agent_version":{"type":"string","description":"Agent version"},"hostname":{"type":"string","description":"Hostname"},"white_label":{"type":"boolean","description":"White label"}},"description":"Doh roaming client create"},"UserAgentConfig":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"User agent id"},"user_agent_uuid":{"type":"string","format":"uuid","description":"User agent uuid"},"agent_local_user_id":{"type":"integer","description":"User agents local user id"},"agent_local_user_uuid":{"type":"string","format":"uuid","description":"User agents local user uuid"},"uninstall":{"type":"boolean","description":"Will be true when the uninstall has been queued"},"clear_registry":{"type":"boolean","description":"User agent clears local config/registry upon remote uninstall"},"updated_at":{"type":"string","format":"date","description":"Configuration timestamp"},"enable_filtering_client":{"type":"boolean","description":"Device will enable or disable filtering client"},"filtering_client_install":{"type":"string","description":"Filtering client install link if enabled"},"enable_cyber_sight":{"type":"boolean","description":"Device will enable or disable filtering client"},"cyber_sight_install":{"type":"string","description":"Cyber sight install link if enabled"},"site_id":{"type":"integer","description":"User agent network id"},"local_domains":{"type":"array","items":{"type":"string"},"description":"Local domains for network"},"local_resolvers":{"type":"array","items":{"type":"string"},"description":"Local resolvers for network"},"organization_id":{"type":"integer","description":"User agent organization id"},"organization_uuid":{"type":"string","format":"uuid","description":"User agent organization uuid"},"msp_id":{"type":"integer","description":"User agent organization msp id"},"msp_uuid":{"type":"string","format":"uuid","description":"User agent organization msp uuid"},"privacy_mode":{"type":"string","enum":["standard","identify_devices","maximum"],"description":"Privacy mode the device configured to use"},"diagnostics_level":{"type":"string","enum":["trace","debug","information","warning","error","critical"],"description":"Diagnostic level the device configured to use"},"connection_method":{"type":"string","enum":["transparent_proxy","loopback"],"description":"Filtering client configured connection method"},"filtering_method":{"type":"string","enum":["precheck","dns_filtering"],"description":"Filtering client configured filtering method"},"fail_over_method":{"type":"string","enum":["fail_open","fail_close"],"description":"Filtering client configured fail over method"},"enable_browser_extension":{"type":"boolean","description":"Cyber sight client configured to use browser extension"},"url_filtering":{"type":"boolean","description":"Cyber sight client configured to do url filtering"},"ip_filtering":{"type":"boolean","description":"Cyber sight client configured to do ip filtering"},"filtering_client_url":{"type":"string","description":"Newer filtering client release url"},"cyber_sight_url":{"type":"string","description":"Newer cyber sight release url"},"enable_vpn":{"type":"boolean","description":"VPN enabled for the device"},"vpn_settings":{"type":"object","properties":{"vpn_provider":{"type":"string"},"vpn_state":{"type":"string"},"vpn_state_friendly_name":{"type":"string"}},"description":"VPN effective settings, includes effective state and friendly name based on user agent and organization level settings"},"enable_pdp":{"type":"boolean","description":"PDP enabled for the device"},"config_urls":{"type":"array","items":{"$ref":"#/components/schemas/ConfigUrl"},"description":"URLs for agent configurations"},"policy_id":{"type":"integer","description":"Effective policy id"},"policy_name":{"type":"string","description":"Effective policy name"}},"description":"User agent config info"},"StatusUpdateSpec":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"User agent id"},"user_agent":{"$ref":"#/components/schemas/UserAgentStatusUpdate"},"cyber_sight_client":{"$ref":"#/components/schemas/CyberSightClientStatusUpdate"},"device_feature":{"$ref":"#/components/schemas/DeviceFeatureStatusUpdate"},"filtering_client":{"$ref":"#/components/schemas/FilteringClientStatusUpdate"},"vpn_client":{"$ref":"#/components/schemas/VpnClientStatusUpdate"}},"required":["id"],"description":"User agent, cyber sight, \u0026 filtering client status update params"},"UserAgentStatusUpdate":{"type":"object","properties":{"status":{"type":"string","enum":["active","error_uninstalling","inactive"],"description":"User agents current status"},"status_code":{"type":"integer","description":"User agents current status code"},"status_message":{"type":"string","description":"User agents current status message"},"agent_version":{"type":"string","description":"User agents current version"}},"description":"User agent status update params"},"DeviceFeatureStatusUpdate":{"type":"object","properties":{"filtering_client_enabled":{"type":"boolean"},"cyber_sight_enabled":{"type":"boolean"},"vpn_client_enabled":{"type":"boolean"},"current_privacy_mode":{"type":"string","enum":["unknown","standard","identify_devices","maximum"]},"current_diagnostics_level":{"type":"string","enum":["unknown","trace","debug","information","warning","error","critical"]},"current_user_local_id":{"type":"string","description":"Currently logged in user local identifier"},"current_user_login":{"type":"string","description":"Currently logged in user local login"},"current_user_name":{"type":"string","description":"Currently logged in user name"}},"description":"Device feature status update para"},"DeviceSettingAttributes":{"type":"object","properties":{"id":{"type":"string","description":"Device setting id"},"enable_cyber_sight":{"type":"boolean"},"enable_filtering_client":{"type":"boolean"},"diagnostics_level":{"type":"string","enum":["unknown","trace","debug","information","warning","error","critical"]}},"description":"Device setting attributes"},"DeviceSettingBulkAttributes":{"type":"object","properties":{"enable_cyber_sight":{"type":"boolean"},"enable_filtering_client":{"type":"boolean","description":"nable_filtering_client [boolean"},"diagnostics_level":{"type":"string","enum":["unknown","trace","debug","information","warning","error","critical"]}},"description":"Device setting bulk attributes"},"FilteringClientStatusUpdate":{"type":"object","properties":{"state":{"type":"string","enum":["not_installed","operational","disabled","error"],"description":"User agents current status"},"version":{"type":"string","description":"Filtering client current version"},"current_connection_method":{"type":"string","enum":["unknown","transparent_proxy","loopback"],"description":"User agents current connection method"},"current_filtering_method":{"type":"string","enum":["unknown","precheck","dns_filtering"],"description":"User agents current filtering method"},"current_fail_over_method":{"type":"string","enum":["unknown","fail_open","fail_close"],"description":"User agents current fail over method"}},"description":"Filtering client status update params"},"FilteringClientSettingAttributes":{"type":"object","properties":{"id":{"type":"string","description":"] Filtering client setting id"},"connection_method":{"type":"string","enum":["unknown","transparent_proxy","loopback"],"description":"User agents connection method"},"filtering_method":{"type":"string","enum":["unknown","precheck","dns_filtering"],"description":"User agents filtering method"},"fail_over_method":{"type":"string","enum":["unknown","fail_open","fail_close"],"description":"User agents fail over method"}},"description":"Filtering client setting attributes"},"FilteringClientSettingBulkAttributes":{"type":"object","properties":{"connection_method":{"type":"string","enum":["unknown","transparent_proxy","loopback"],"description":"User agents connection method"},"filtering_method":{"type":"string","enum":["unknown","precheck","dns_filtering"],"description":"User agents filtering method"},"fail_over_method":{"type":"string","enum":["unknown","fail_open","fail_close"],"description":"User agents fail over method"}},"description":"Filtering client setting bulk attributes"},"VpnClientStatusUpdate":{"type":"object","properties":{"status":{"type":"string","enum":["disconnected","connected","error"],"description":"VPN client status"},"last_connected_at":{"type":"integer","description":"Unix timestamp of last successful VPN connection"},"last_error_at":{"type":"integer","description":"Unix timestamp of last VPN error"}},"description":"VPN client status update params"},"CyberSightClientStatusUpdate":{"type":"object","properties":{"service_state":{"type":"string","enum":["operational","disabled","error"],"description":"CyberSight clients current state"},"service_version":{"type":"string","description":"CyberSight agent version"},"chrome_extension_status":{"type":"string","enum":["operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"],"description":"CyberSight clients current chrome extension state"},"edge_extension_status":{"type":"string","enum":["operational","disabled","error","outdated","install_disabled","browser_not_installed","not_communicating"],"description":"CyberSight clients current edge extension state"},"upstream_communication_state":{"type":"string","enum":["operational","disabled","error"],"description":"CyberSight clients current upstream communication state"},"url_filtering":{"type":"boolean","description":"CyberSight clients currently url filtering"},"ip_filtering":{"type":"boolean","description":"CyberSight clients currently ip filtering"}},"description":"Cyber sight status update params"},"VpnSettingsUserAgentAttributes":{"type":"object","properties":{"_destroy":{"type":"boolean","description":"destroy record by setting to true"},"vpn_settings_state_type_id":{"type":"integer","description":"id for vpn settings state type"}},"description":"VPN settings user agent attributes"},"UserAgentAutoUpdate":{"type":"object","properties":{"update_filtering_client":{"type":"boolean","description":"Newer filtering client release found"},"update_cyber_sight":{"type":"boolean","description":"Newer cyber sight release found"},"filtering_client_url":{"type":"string","description":"Newer filtering client release url"},"cyber_sight_url":{"type":"string","description":"Newer cyber sight release url"}},"description":"Feature releases if any updates found"},"UserAgentSettingsBody":{"type":"object","properties":{"device_setting_attributes":{"$ref":"#/components/schemas/DeviceSettingAttributes"},"filtering_client_setting_attributes":{"$ref":"#/components/schemas/FilteringClientSettingAttributes"}},"description":"Payload for user agent settings"},"ConfigUrl":{"type":"object","properties":{"url":{"type":"string","description":"the URL for the configurations"},"config_type":{"type":"string","description":"what the URL is used to configure"},"updated_at":{"type":"string","format":"date","description":"the date that the URL was last updated"}},"description":"A URL used for configuring the RC"},"User":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"email":{"type":"string","description":"Email address"},"email_verified":{"type":"boolean","description":"Email address is verified (may be null)"},"created_at":{"type":"string","format":"date","description":"Creation date"},"updated_at":{"type":"string","format":"date","description":"Last update"},"has_agreements_to_sign":{"type":"boolean","description":"User has agreements to sign"},"can_add_org_to_msps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"description":"Optional list of MSPs user can add organizations to"}},"description":"User resource"},"UserSpec":{"allOf":[{"$ref":"#/components/schemas/IdType"},{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/User"}}}],"description":"User specification"},"UserCreate":{"type":"object","properties":{"name":{"type":"string","description":"User full name"},"email":{"type":"string","description":"Email address"}},"required":["name","email"],"description":"User creation request parameters"},"UserCreateSpec":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserCreate"},"membership":{"$ref":"#/components/schemas/UserMembershipCreate"}},"required":["user","membership"],"description":"User creation request parameters"},"UserMembershipCreate":{"type":"object","properties":{"organization_id":{"type":"integer","description":"Organization resource ID"},"role":{"type":"string","enum":["administrator","read_only","network_administrator","network_support","support"],"description":"User role"}},"description":"User membership creation request parameters"},"UserUpdateSpec":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserCreate"}},"required":["user"],"description":"User update request parameters"},"VpnSettingsStateType":{"type":"object","properties":{"id":{"type":"integer","description":"State type ID"},"name":{"type":"string","description":"The name of the state type"},"friendly_name":{"type":"string","description":"The friendly/display name that can be shown to the user"},"description":{"type":"string","description":"Simple description of the state type"}},"description":"Vpn Settings State Types"},"VpnGuardianSubscriptionValidationResult":{"type":"object","properties":{"ep-grd-subscriber-identifier":{"type":"string","description":"The subscriber identifier"},"subscription-sku":{"type":"string","description":"The subscription SKU"},"subscription-name-formatted":{"type":"string","description":"Formatted subscription name"},"subscription-expiration-timestamp":{"type":"integer","description":"The expiration timestamp of the subscription"}}},"VpnGuardianSubscriptionValidationRequest":{"type":"object","properties":{"ep-grd-subscriber-identifier":{"type":"string","description":"The subscriber identifier for the VPN subscription"},"ep-grd-subscriber-secret":{"type":"string","description":"The subscriber secret for the VPN subscription"}}},"VpnGuardianSubscriptionValidationError":{"type":"object","properties":{"error-code":{"type":"string","description":"The error code representing the type of error that occurred during VPN subscription validation"},"error-title":{"type":"string","description":"A brief, human-readable title describing the error that occurred during VPN subscription validation"},"error-message":{"type":"string","description":"A human-readable message providing more details about the error that occurred during VPN subscription validation"}}}},"securitySchemes":{"header_authorization":{"type":"apiKey","name":"Authorization","in":"header"}}}}