diff --git a/README.MD b/README.MD index 9d90cf7..e4c678d 100644 --- a/README.MD +++ b/README.MD @@ -1,9 +1,17 @@ # IT Glue API Specifications and Clients -This repository contains the OpenAPI specifications for the IT Glue API. +This repository contains the OpenAPI specifications for Kaseya's IT Glue API. **IT IS AUTOMATICALLY GENERATED FROM THEIR MAIN API DOCUMENTATION BY THE PYTHON SCRIPT IN THIS REPOSITORY.** -The python script, in turn, was created nearly entirely by ChatGPT o1-preview. -The script runs automatically daily from Github and will update the OpenAPI specifications in this repository with the latest changes from the IT Glue API documentation with a new commit. \ No newline at end of file + +The Python script, in turn, was created nearly entirely by ChatGPT o1-preview. + +The script runs automatically daily from Github and will update the OpenAPI specifications in this repository with the latest changes from the IT Glue API documentation with a new commit. + +**Try it out at [Swagger Editor](https://editor.swagger.io/)** and copy and paste the contents of the `itgapi.yaml` file in this repository. + +This project has NO official affiliation with Kaseya or IT Glue. It is a personal effort to provide OpenAPI specifications for the IT Glue API. + +Note to Kaseya: This would be much easier if you'd provide an OpenAPI specification directly. Please consider it. \ No newline at end of file diff --git a/docs-to-yaml.py b/docs-to-yaml.py index 678b141..8a272fd 100644 --- a/docs-to-yaml.py +++ b/docs-to-yaml.py @@ -73,6 +73,22 @@ def get_param_type(validations): else: return 'string' +# Function to check for duplicate parameters +def add_parameter(parameters_list, new_param): + for param in parameters_list: + if param['name'] == new_param['name'] and param['in'] == new_param['in']: + # Duplicate found, do not add + return + parameters_list.append(new_param) + +# Define endpoints that support filtering and their available filters +available_filters = { + '/users_metrics': ['date', 'user_ID'], + '/configurations': ['name', 'status', 'organization_id'], + '/organizations': ['name', 'status'], + # Add more endpoints and their filters as needed +} + # Step 5: Iterate over each div and extract the necessary information for div in divs: # Get the class name @@ -103,27 +119,30 @@ def get_param_type(validations): if path not in openapi_spec['paths']: openapi_spec['paths'][path] = {} # Initialize the method details - openapi_spec['paths'][path][method] = { - 'summary': '', - 'description': '', - 'parameters': [], - 'responses': { - '200': { - 'description': 'Successful response', - 'content': { - 'application/json': { - 'schema': { - 'type': 'object' + if method not in openapi_spec['paths'][path]: + openapi_spec['paths'][path][method] = { + 'summary': '', + 'description': '', + 'parameters': [], + 'responses': { + '200': { + 'description': 'Successful response', + 'content': { + 'application/json': { + 'schema': { + 'type': 'object' + } } } } - } - }, - 'security': [{'apiKeyAuth': []}] - } + }, + 'security': [{'apiKeyAuth': []}] + } + # Reference to parameters list + parameters = openapi_spec['paths'][path][method]['parameters'] # Add path parameters to parameters list for param in path_params: - openapi_spec['paths'][path][method]['parameters'].append({ + param_obj = { 'name': param, 'in': 'path', 'description': '', @@ -131,7 +150,59 @@ def get_param_type(validations): 'schema': { 'type': 'string' # Default to string, adjust based on actual type if available } - }) + } + add_parameter(parameters, param_obj) + # Add paging, sorting, and filtering parameters for GET methods + if method == 'get': + # Add paging parameters + paging_params = [ + { + 'name': 'page[size]', + 'in': 'query', + 'description': 'Number of items per page (max 1000)', + 'required': False, + 'schema': { + 'type': 'integer', + 'maximum': 1000 + } + }, + { + 'name': 'page[number]', + 'in': 'query', + 'description': 'Page number to retrieve', + 'required': False, + 'schema': { + 'type': 'integer', + 'minimum': 1 + } + } + ] + for param in paging_params: + add_parameter(parameters, param) + # Add sorting parameter + sort_param = { + 'name': 'sort', + 'in': 'query', + 'description': 'Field by which to sort the results. Prepend \'-\' for descending order.', + 'required': False, + 'schema': { + 'type': 'string' + } + } + add_parameter(parameters, sort_param) + # Add filtering parameters based on known filters + filters = available_filters.get(path, []) + for filter_param in filters: + filter_obj = { + 'name': f'filter[{filter_param}]', + 'in': 'query', + 'description': f'Filter results by {filter_param}', + 'required': False, + 'schema': { + 'type': 'string' # Adjust type as needed + } + } + add_parameter(parameters, filter_obj) # Extract description and parameters article = div.find('article') if article: @@ -139,6 +210,12 @@ def get_param_type(validations): description = article.find('p') if description: openapi_spec['paths'][path][method]['description'] = description.get_text(strip=True) + # Add note about pagination limits + if method == 'get': + openapi_spec['paths'][path][method]['description'] += ( + "\n\nNote: The maximum number of results that can be requested is 1000." + " If your requests are timing out, try lowering the page size." + ) # Parameters params_heading = article.find('h2', string='Params') if params_heading: @@ -156,22 +233,22 @@ def get_param_type(validations): # Determine if the parameter is required required = 'required' in param_info # Determine the parameter location - # If the parameter is already in path parameters, skip adding again - if param_name in path_params: - # Update the description of the existing path parameter - for p in openapi_spec['paths'][path][method]['parameters']: - if p['name'] == param_name and p['in'] == 'path': - p['description'] = param_description - # Determine the parameter type - validations_div = desc_cell.find('div', string=re.compile('Validations:')) - param_type = 'string' - if validations_div: - validations_text = validations_div.find_next('ul').get_text() - param_type = get_param_type(validations_text) - p['schema']['type'] = param_type - break - continue - else: + # Check if parameter is already in parameters list + param_in_list = False + for p in parameters: + if p['name'] == param_name: + param_in_list = True + # Update description and schema if needed + p['description'] = param_description + # Determine the parameter type + validations_div = desc_cell.find('div', string=re.compile('Validations:')) + param_type = 'string' + if validations_div: + validations_text = validations_div.find_next('ul').get_text() + param_type = get_param_type(validations_text) + p['schema']['type'] = param_type + break + if not param_in_list: param_in = 'query' # Determine the parameter type validations_div = desc_cell.find('div', string=re.compile('Validations:')) @@ -180,8 +257,8 @@ def get_param_type(validations): validations_text = validations_div.find_next('ul').get_text() param_type = get_param_type(validations_text) # Clean up parameter name - param_name = param_name.replace('[', '.').replace(']', '') - openapi_spec['paths'][path][method]['parameters'].append({ + param_name_clean = param_name.replace('[', '.').replace(']', '') + param_obj = { 'name': param_name, 'in': param_in, 'description': param_description, @@ -189,7 +266,8 @@ def get_param_type(validations): 'schema': { 'type': param_type } - }) + } + add_parameter(parameters, param_obj) # Responses errors_heading = article.find('h2', string='Errors') if errors_heading: @@ -214,4 +292,4 @@ def get_param_type(validations): yaml_output = yaml.dump(openapi_spec, sort_keys=False, allow_unicode=True) # Step 8: Output the YAML -print(yaml_output) +print(yaml_output) \ No newline at end of file diff --git a/itg.yaml b/itg.yaml deleted file mode 100644 index a95fbd3..0000000 --- a/itg.yaml +++ /dev/null @@ -1,8956 +0,0 @@ -openapi: 3.0.0 -info: - title: ITGlue API - version: 1.0.0 - description: '**Authentication/Request Headers** - - - All API requests require the following headers: - - - - `x-api-key: {{api-token}}` - - - `Content-Type: application/vnd.api+json` - - - Note: If the request does not have a payload, the `Content-Type` header is not - required.' -servers: -- url: https://api.itglue.com - description: Default API server -- url: https://api.eu.itglue.com - description: EU data center -- url: https://api.au.itglue.com - description: Australia data center -paths: - /configuration_interfaces: - post: - summary: '' - description: Creates a new configuration interface under the configuration specified - in the ID parameter. Returns the created object if successful. Use - the nested relationships route to add multiple configuration interfaces - to a configuration in bulk. - parameters: - - name: configuration_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid configuration ID in your account.' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configuration_interfaces. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.configuration_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.ip_address - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mac_address - in: query - description: Must be a valid MAC addressValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /configuration_interfaces/{id}: - get: - summary: '' - description: Returns the details of an existing configuration interface. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: configuration_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid configuration ID in your account.' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /configuration_statuses: - get: - summary: '' - description: Returns a list of the configuration statuses in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new configuration status in your account. Returns the - created object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configuration_statuses. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /configuration_statuses/{id}: - get: - summary: '' - description: Returns the details of an existing configuration status. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /configuration_types: - get: - summary: '' - description: Returns a list of configuration types in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new configuration type in your account. Returns the created - object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configuration_types. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Bad Request - security: - - apiKeyAuth: [] - /configuration_types/{id}: - get: - summary: '' - description: Returns the details of an existing configuration type. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /configurations: - get: - summary: '' - description: Returns a list of configurations for all organizations or for a - specified organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.mac_address - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.rmm_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for rmm_integration_type' - required: false - schema: - type: string - - name: filter.rmm_integration_type - in: query - description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,passwords,attachments,tickets,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a configuration under the organization specified in the - ID parameter. Returns the created object if successful. Use the nested - relationships route to add multiple configurations to an organization in bulk. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configurations. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.configuration_type_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.location_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.manufacturer_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.model_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.operating_system_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.operating_system_notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.hostname - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.primary_ip - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mac_address - in: query - description: 17 Character limitValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.default_gateway - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.position - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.installed_by - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.purchased_by - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.purchased_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.warranty_expires_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mitp_device_expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mitp_end_of_life_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.installed_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships - in: query - description: Not permitted in PUT/PATCH, optional in POSTValidations:Must - be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data - in: query - description: Can contain multiple InterfacesValidations:Must be an Array of - nested elements - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cconfiguration_interfacesâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80\ - ¦}Validations:Must be a Hash" - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data._.type - in: query - description: Validations:Must be one of:configuration_interfaces. - required: true - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data._.attributes.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.ip_address - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.mac_address - in: query - description: Must be a valid MAC addressValidations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified configurations. Returns the deleted - configurations and a 200 status code if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cconfigurationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:configurations. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.mac_address - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.rmm_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for rmm_integration_type' - required: false - schema: - type: string - - name: filter.rmm_integration_type - in: query - description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /configurations/{configuration_id}/relationships/configuration_interfaces: - get: - summary: '' - description: Returns the configuration interfaces for a specified configuration. - parameters: - - name: configuration_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid configuration ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.ip_address - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new configuration interface under the configuration specified - in the ID parameter. Returns the created object if successful. Use - the nested relationships route to add multiple configuration interfaces - to a configuration in bulk. - parameters: - - name: configuration_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid configuration ID in your account.' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configuration_interfaces. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.configuration_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.ip_address - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mac_address - in: query - description: Must be a valid MAC addressValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /configurations/{configuration_id}/relationships/configuration_interfaces/{id}: - get: - summary: '' - description: Returns the details of an existing configuration interface. - parameters: - - name: configuration_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid configuration ID in your account.' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /configurations/{id}: - get: - summary: '' - description: Returns the details of an existing configuration. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,rmm_adapters_resources,passwords,attachments,tickets,adapters_resources_errors,rmm_adapters_resources_errors,active_network_glue_network_devices,to_configuration_connections,from_configuration_connections,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /contact_types: - get: - summary: '' - description: Returns a list of contact types in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new contact type in your account. Returns the created - object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:contact_types. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /contact_types/{id}: - get: - summary: '' - description: Returns the details of an existing contact type. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /contacts: - get: - summary: '' - description: Returns a list of contacts for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: filter.primary_email - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a contact under the organization specified in the organization_id - parameter. Returns the created object if successful. Use the nested - relationships route to add multiple contacts to an organization in - bulk. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:contacts. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.location_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.contact_emails - in: query - description: Can contain multiple emailsValidations:Must be an Array of nested - elements - required: false - schema: - type: string - - name: data.contact_emails._ - in: query - description: "Nameless hash, should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ - \x9Cemail@company.comâ\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data.contact_emails._.value - in: query - description: Must be a valid email address formatValidations:Must be a String - required: true - schema: - type: string - - name: data.contact_emails._.label_name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.contact_emails._.primary - in: query - description: Defaults to false if not provided.Validations:Must be one of:true,false. - required: false - schema: - type: string - - name: data.contact_phones - in: query - description: Can contain multiple phonesValidations:Must be an Array of nested - elements - required: false - schema: - type: string - - name: data.contact_phones._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ - \x9C2341112233â\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data.contact_phones._.value - in: query - description: Phone numbers are stripped of all separators.Validations:Must - be a String - required: true - schema: - type: string - - name: data.contact_phones._.label_name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.contact_phones._.extension - in: query - description: Phone extensions are stripped of all separators.Validations:Must - be a String - required: false - schema: - type: string - - name: data.contact_phones._.primary - in: query - description: Defaults to false if not provided.Validations:Must be one of:true,false. - required: false - schema: - type: string - - name: data.contact_phones._.label_type - in: query - description: Defaults to phone if not provided.Validations:Must be one of:phone,fax. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified contacts. Returns the deleted contacts - and a 200 status code if successful. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Ccontactsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:contacts. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: filter.primary_email - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /contacts/{id}: - get: - summary: '' - description: Returns the details of an existing contact. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /copilot_smart_assist/documents: - get: - summary: '' - description: Offer analytics on documentation usage, such as 'Documents not - viewed in X amount of time', 'Documents that were never viewed', 'Documents - that are expired', and 'Duplicate documents'. - parameters: - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.type - in: query - description: Validations:Must be one of:stale,not_viewed,expired. - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified documents. Returns the deleted documents - and a 200 status code if successful. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.type - in: query - description: Validations:Must be one of:stale,not_viewed,expired. - required: false - schema: - type: string - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cdocumentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:documents. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data._.attributes.archived - in: query - description: Validations:Must be one of:true,false. - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - security: - - apiKeyAuth: [] - /countries: - get: - summary: '' - description: Returns a list of supported countries. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: filter.iso - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /countries/{country_id}/relationships/regions: - get: - summary: '' - description: Returns a list of supported regions. - parameters: - - name: country_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid country ID.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: filter.iso - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /countries/{country_id}/relationships/regions/{id}: - get: - summary: '' - description: Returns the details of one of the supported regions. - parameters: - - name: country_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid country ID.' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /countries/{id}: - get: - summary: '' - description: Returns the details of one of the supported countries. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /domains: - get: - summary: '' - description: Returns a list of domains for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:passwords,attachments,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /expirations: - get: - summary: '' - description: Returns a list of expirations for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.resource_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.resource_type_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.description - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.range - in: query - description: "To filter on a specific range, supply two comma-separated values\ - \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ - \ or equal to 2 and less than or equal to 10). Or, an asterisk ( * ) can\ - \ filter on values either greater than or equal to (e.g. â\x80\x9C2, *â\x80\ - \x9D), or less than or equal to (â\x80\x9C*, 10â\x80\x9D)Validations:Must\ - \ be a HashMetadata:Param Type: CGI" - required: false - schema: - type: object - - name: filter.range.expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /expirations/{id}: - get: - summary: '' - description: Returns a single expiration with the given ID or a single expiration - for a specified organization. - parameters: - - name: id - in: path - description: '' - required: true - schema: - type: string - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /exports: - get: - summary: '' - description: Returns a list of exports in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new export under the current account. The new export - will be for a single organization if organization_id is specified; otherwise - The new export will be for all organizations of the current account. Returns - the created export record if successful. - parameters: - - name: type - in: query - description: Validations:Must be one of:exports. - required: true - schema: - type: string - - name: attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: attributes.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: attributes.include_logs - in: query - description: Defaults to false if not providedValidations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: attributes.zip_password - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /exports/{id}: - get: - summary: '' - description: '''Retrieve a particular export for current account.''' - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of: .Metadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Delete an export. Returns a 204 status code if successful. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /flexible_asset_types: - get: - summary: '' - description: Returns a list of flexible asset types in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.icon - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.enabled - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:id,name,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:flexible_asset_fields.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new flexible asset type in your account. Returns the - created object if successful. Use the nested relationships route to add multiple - flexible asset fields to a flexible asset type in bulk. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:flexible_asset_types. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.description - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.icon - in: query - description: icon image nameValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.enabled - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.fields - in: query - description: List of fields for this flexible asset type; each flexible asset - type must have at least one field and at least one field with show_in_list - set to trueValidations:Must be an Array of nested elements - required: true - schema: - type: string - - name: data.attributes.fields.id - in: query - description: Required identifier for updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.fields.flexible_asset_type_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.fields.order - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.fields.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.fields.kind - in: query - description: Kind cannot be changed once there are traits created for the - fieldValidations:Must be one of:Checkbox,Date,Header,Number,Select,Text,Textbox,Upload,Tag,Percent,Password. - required: true - schema: - type: string - - name: data.attributes.fields.hint - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.fields.decimals - in: query - description: A non-negative required value if field type is Number or PercentValidations:Must - be a number. - required: false - schema: - type: integer - - name: data.attributes.fields.default_value - in: query - description: Required if field type is SelectValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.fields.tag_type - in: query - description: 'Validations:Must be one of:AccountsUsers,Checklists,ChecklistTemplates,Contacts,Configurations,Documents,Domains,Passwords,Locations,Organizations,SslCertificates,Tickets,FlexibleAssetType: - id.' - required: false - schema: - type: string - - name: data.attributes.fields.required - in: query - description: Indicates if the field is required for the flexible asset; it - will be set to false if the field type is HeaderValidations:Must be one - of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.fields.use_for_title - in: query - description: 'Indicates if the field name should be added to the flexible - asset name; it will be set to false if the field type is one of: Checkbox, - Header, Number, Password, Percent, Step, Tag, Textbox, UploadValidations:Must - be one of:true,false,1,0.' - required: false - schema: - type: string - - name: data.attributes.fields.expiration - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.fields.show_in_list - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships - in: query - description: Not permitted in PUT/PATCH, optional in POSTValidations:Must - be a Hash - required: false - schema: - type: object - - name: data.relationships.flexible_asset_fields - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.flexible_asset_fields.data - in: query - description: Can contain multiple Flexible Asset FieldsValidations:Must be - an Array of nested elements - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cflexible_asset_fieldsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data.relationships.flexible_asset_fields.data._.type - in: query - description: Validations:Must be one of:flexible_asset_fields. - required: true - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.flexible_asset_fields.data._.attributes.order - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.relationships.flexible_asset_fields.data._.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.kind - in: query - description: Kind cannot be changed once there are traits created for the - fieldValidations:Must be one of:Checkbox,Date,Header,Number,Select,Text,Textbox,Upload,Tag,Percent,Password. - required: true - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.hint - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.decimals - in: query - description: A non-negative required value if field type is Number or PercentValidations:Must - be a number. - required: false - schema: - type: integer - - name: data.relationships.flexible_asset_fields.data._.attributes.default_value - in: query - description: Required if field type is SelectValidations:Must be a String - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.tag_type - in: query - description: 'Validations:Must be one of:AccountsUsers,Checklists,ChecklistTemplates,Contacts,Configurations,Documents,Domains,Passwords,Locations,Organizations,SslCertificates,Tickets,FlexibleAssetType: - id.' - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.required - in: query - description: Indicates if the field is required for the flexible asset; it - will be set to false if the field type is HeaderValidations:Must be one - of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.use_for_title - in: query - description: 'Indicates if the field name should be added to the flexible - asset name; it will be set to false if the field type is one of: Checkbox, - Header, Number, Password, Percent, Step, Tag, Textbox, UploadValidations:Must - be one of:true,false,1,0.' - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.expiration - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.show_in_list - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - security: - - apiKeyAuth: [] - /flexible_asset_types/{id}: - get: - summary: '' - description: Returns the details of an existing flexible asset type. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:flexible_asset_fields.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /flexible_assets: - get: - summary: '' - description: Returns a list of flexible assets based on the unique ID of the - flexible asset type. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Description: All filter params have to be exact match only' - required: true - schema: - type: object - - name: filter.flexible-asset-type-id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization-id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,distinct_remote_assets,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new flexible asset. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:flexible_assets. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.organization_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.flexible_asset_type_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.traits - in: query - description: A hash of key value pairs for the traits of this asset. Values - can be arrays. The key has to be an available field key from the specified - flexible asset type.Validations:Must be a Hash - required: true - schema: - type: object - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified flexible assets. Returns the deleted - flexible assets and a 200 status code if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cflexible_assetsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:flexible_assets. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter.flexible_asset_type_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - security: - - apiKeyAuth: [] - /flexible_assets/{id}: - get: - summary: '' - description: Returns the details of an existing flexible asset. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,distinct_remote_assets,attachments,passwords,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Destroys a single flexible asset with its ID. Returns a 204 status - code if successful. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /groups: - get: - summary: '' - description: Returns a list of groups in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:users.Metadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /groups/{id}: - get: - summary: '' - description: Returns the details of an existing group. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:users.Metadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /locations: - get: - summary: '' - description: Returns a list of locations for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new location under the specified organization. The :organization_id - is specified in the URL or in the request body for `/locations` route. - Returns a 201 status on success; the created object is returned the response - body. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:locations. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.address_1 - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.address_2 - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.postal_code - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.phone - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.fax - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified locations. Returns the deleted locations - and a 200 status code if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Clocationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:locations. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /locations/{id}: - get: - summary: '' - description: Returns the details of an existing location. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /logs: - get: - summary: '' - description: Get all activity logs of the account for most recent 30 days. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.created_at - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:created_at.Metadata:Param Type: CGI\n\ - Notes: |\n To Invert order use -, eg: -name\n Comma separated values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: 'Validations:Must be a number.Metadata:Notes: Must be a value - between 1 and 5 (inclusive).' - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /manufacturers: - get: - summary: '' - description: Returns a list of the manufacturer names in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new manufacturer name. Returns the created object if - successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:manufacturers. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /manufacturers/{id}: - get: - summary: '' - description: Returns the details of an existing manufacturer name. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /manufacturers/{manufacturer_id}/relationships/models: - get: - summary: '' - description: Returns a list of model names for all manufacturers or for a specified - manufacturer. - parameters: - - name: manufacturer_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:id,name,manufacturer_id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a model name under the manufacturer specified in the ID - parameter. Returns the created object if successful. Use the nested relationships - route to add multiple models to a manufacturer in bulk. - parameters: - - name: manufacturer_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:models. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.manufacturer_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /manufacturers/{manufacturer_id}/relationships/models/{id}: - get: - summary: '' - description: Returns the details of an existing model name. - parameters: - - name: manufacturer_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /models: - get: - summary: '' - description: Returns a list of model names for all manufacturers or for a specified - manufacturer. - parameters: - - name: manufacturer_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:id,name,manufacturer_id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a model name under the manufacturer specified in the ID - parameter. Returns the created object if successful. Use the nested relationships - route to add multiple models to a manufacturer in bulk. - parameters: - - name: manufacturer_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:models. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.manufacturer_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /models/{id}: - get: - summary: '' - description: Returns the details of an existing model name. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: manufacturer_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /operating_systems: - get: - summary: '' - description: Returns a list of supported operating systems. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /operating_systems/{id}: - get: - summary: '' - description: Returns the details of one of the supported operating systems. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organization_statuses: - get: - summary: '' - description: Returns a list of the organization statuses in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new organization status in your account. Returns the - created object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:organization_statuses. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organization_statuses/{id}: - get: - summary: '' - description: Returns the details of an existing organization status. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organization_types: - get: - summary: '' - description: Returns a list of organization types in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new organization type in your account. Returns the created - object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:organization_types. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organization_types/{id}: - get: - summary: '' - description: Returns the details of an existing organization type. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organizations: - get: - summary: '' - description: Returns a list of organizations in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.created_at - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: filter.updated_at - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: filter.my_glue_account_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.group_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.primary - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.exclude - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.exclude.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.exclude.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.exclude.organization_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.exclude.organization_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.range - in: query - description: "To filter on a specific range, supply two comma-separated values\ - \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ - \ or equal to 2 and less than or equal to 10). Or, an asterisk ( * ) can\ - \ filter on values either greater than or equal to (e.g. â\x80\x9C2, *â\x80\ - \x9D), or less than or equal to (â\x80\x9C*, 10â\x80\x9D)Validations:Must\ - \ be a HashMetadata:Param Type: CGI" - required: false - schema: - type: object - - name: filter.range.my_glue_account_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,updated_at,organization_status_name,organization_type_name,created_at,short_name,my_glue_account_id.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,rmm_companies.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates an organization. Returns the created object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:organizations. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.alert - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.description - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.organization_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.quick_notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.short_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.parent_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Marks organizations identified by the specified organization IDs - for deletion. Because it can be a long procedure to delete organizations, - removal from the system may not happen immediately. - parameters: - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Corganizationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:organizations. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.created_at - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: filter.updated_at - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: filter.my_glue_account_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.group_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.primary - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.exclude - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.exclude.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.exclude.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.exclude.organization_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.exclude.organization_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{id}: - get: - summary: '' - description: Returns the details of an existing organization. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,rmm_companies.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organizations/{organization_id}/copilot_smart_assist/documents: - delete: - summary: '' - description: Deletes one or more specified documents. Returns the deleted documents - and a 200 status code if successful. - parameters: - - name: organization_id - in: path - description: '' - required: true - schema: - type: string - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.type - in: query - description: Validations:Must be one of:stale,not_viewed,expired. - required: false - schema: - type: string - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cdocumentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:documents. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data._.attributes.archived - in: query - description: Validations:Must be one of:true,false. - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/configurations: - get: - summary: '' - description: Returns a list of configurations for all organizations or for a - specified organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.mac_address - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.rmm_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for rmm_integration_type' - required: false - schema: - type: string - - name: filter.rmm_integration_type - in: query - description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,passwords,attachments,tickets,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a configuration under the organization specified in the - ID parameter. Returns the created object if successful. Use the nested - relationships route to add multiple configurations to an organization in bulk. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:configurations. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.configuration_type_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.location_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.manufacturer_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.model_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.operating_system_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.operating_system_notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.hostname - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.primary_ip - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mac_address - in: query - description: 17 Character limitValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.default_gateway - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.position - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.installed_by - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.purchased_by - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.purchased_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.warranty_expires_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mitp_device_expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.mitp_end_of_life_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.installed_at - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships - in: query - description: Not permitted in PUT/PATCH, optional in POSTValidations:Must - be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data - in: query - description: Can contain multiple InterfacesValidations:Must be an Array of - nested elements - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cconfiguration_interfacesâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80\ - ¦}Validations:Must be a Hash" - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data._.type - in: query - description: Validations:Must be one of:configuration_interfaces. - required: true - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.configuration_interfaces.data._.attributes.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.ip_address - in: query - description: IP4 and IP6 are supportedValidations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.mac_address - in: query - description: Must be a valid MAC addressValidations:Must be a String - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.relationships.configuration_interfaces.data._.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified configurations. Returns the deleted - configurations and a 200 status code if successful. - parameters: - - name: organization_id - in: path - description: '' - required: true - schema: - type: string - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cconfigurationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:configurations. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.configuration_status_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.contact_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.serial_number - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.mac_address - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.asset_tag - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: filter.rmm_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for rmm_integration_type' - required: false - schema: - type: string - - name: filter.rmm_integration_type - in: query - description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/configurations/{id}: - get: - summary: '' - description: Returns the details of an existing configuration. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,rmm_adapters_resources,passwords,attachments,tickets,adapters_resources_errors,rmm_adapters_resources_errors,active_network_glue_network_devices,to_configuration_connections,from_configuration_connections,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/contacts: - get: - summary: '' - description: Returns a list of contacts for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: filter.primary_email - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a contact under the organization specified in the organization_id - parameter. Returns the created object if successful. Use the nested - relationships route to add multiple contacts to an organization in - bulk. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:contacts. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.location_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.contact_emails - in: query - description: Can contain multiple emailsValidations:Must be an Array of nested - elements - required: false - schema: - type: string - - name: data.contact_emails._ - in: query - description: "Nameless hash, should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ - \x9Cemail@company.comâ\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data.contact_emails._.value - in: query - description: Must be a valid email address formatValidations:Must be a String - required: true - schema: - type: string - - name: data.contact_emails._.label_name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.contact_emails._.primary - in: query - description: Defaults to false if not provided.Validations:Must be one of:true,false. - required: false - schema: - type: string - - name: data.contact_phones - in: query - description: Can contain multiple phonesValidations:Must be an Array of nested - elements - required: false - schema: - type: string - - name: data.contact_phones._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ - \x9C2341112233â\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data.contact_phones._.value - in: query - description: Phone numbers are stripped of all separators.Validations:Must - be a String - required: true - schema: - type: string - - name: data.contact_phones._.label_name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.contact_phones._.extension - in: query - description: Phone extensions are stripped of all separators.Validations:Must - be a String - required: false - schema: - type: string - - name: data.contact_phones._.primary - in: query - description: Defaults to false if not provided.Validations:Must be one of:true,false. - required: false - schema: - type: string - - name: data.contact_phones._.label_type - in: query - description: Defaults to phone if not provided.Validations:Must be one of:phone,fax. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified contacts. Returns the deleted contacts - and a 200 status code if successful. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Ccontactsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:contacts. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.first_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.last_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.title - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.contact_type_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.important - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: filter.primary_email - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/contacts/{id}: - get: - summary: '' - description: Returns the details of an existing contact. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/domains: - get: - summary: '' - description: Returns a list of domains for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:passwords,attachments,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/expirations: - get: - summary: '' - description: Returns a list of expirations for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.resource_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.resource_type_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.description - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.range - in: query - description: "To filter on a specific range, supply two comma-separated values\ - \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ - \ or equal to 2 and less than or equal to 10). Or, an asterisk ( * ) can\ - \ filter on values either greater than or equal to (e.g. â\x80\x9C2, *â\x80\ - \x9D), or less than or equal to (â\x80\x9C*, 10â\x80\x9D)Validations:Must\ - \ be a HashMetadata:Param Type: CGI" - required: false - schema: - type: object - - name: filter.range.expiration_date - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/expirations/{id}: - get: - summary: '' - description: Returns a single expiration with the given ID or a single expiration - for a specified organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: id - in: path - description: '' - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/flexible_assets: - post: - summary: '' - description: Creates a new flexible asset. - parameters: - - name: organization_id - in: path - description: '' - required: true - schema: - type: string - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:flexible_assets. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.organization_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.flexible_asset_type_id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.traits - in: query - description: A hash of key value pairs for the traits of this asset. Values - can be arrays. The key has to be an available field key from the specified - flexible asset type.Validations:Must be a Hash - required: true - schema: - type: object - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/locations: - get: - summary: '' - description: Returns a list of locations for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new location under the specified organization. The :organization_id - is specified in the URL or in the request body for `/locations` route. - Returns a 201 status on success; the created object is returned the response - body. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:locations. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.primary - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.address_1 - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.address_2 - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.postal_code - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.phone - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.fax - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/locations/{id}: - get: - summary: '' - description: Returns the details of an existing location. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified locations. Returns the deleted locations - and a 200 status code if successful. - parameters: - - name: organization_id - in: path - description: '' - required: true - schema: - type: string - - name: id - in: path - description: '' - required: true - schema: - type: string - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Clocationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:locations. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.city - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.region_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.psa_id - in: query - description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied - by the filter for psa_integration_type' - required: false - schema: - type: string - - name: filter.psa_integration_type - in: query - description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/passwords: - get: - summary: '' - description: Returns a list of passwords for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.cached_resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a password under the organization specified in the ID parameter. - Returns the created object if successful. Use the nested relationships route - to add multiple passwords to an organization in bulk. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: show_password - in: query - description: 'defaults to ''false'', Can be set to ''true'' to return the - passwordValidations:Must be one of:true,false.Metadata:Param Type: In URL' - required: false - schema: - type: string - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:passwords. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.username - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.password - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.otp_secret - in: query - description: One Time Password secretValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.resource_id - in: query - description: Must be used together with `resource_type`Validations:Must be - a number. - required: false - schema: - type: integer - - name: data.attributes.resource_type - in: query - description: Must be used together with `resource_id`Validations:Must be one - of:Configuration,Contact,Document,Domain,Location,SSL Certificate,Flexible - Asset,Ticket. - required: false - schema: - type: string - - name: data.attributes.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.password_updated_at - in: query - description: Date the password last changedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.autofill_selectors - in: query - description: Used for identification of fields for password autofillValidations:Must - be a String - required: false - schema: - type: string - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.is_live - in: query - description: Used for understanding - is this a live version of the password - or not.Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.generated_password_type - in: query - description: This value indicates if the user is using the complex password - feature, and if the password is complex or pronounceable.Validations:Must - be a String - required: false - schema: - type: string - - name: data.relationships - in: query - description: Not permitted in PUT/PATCH, optional in POSTValidations:Must - be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category - in: query - description: Can belong to one password categoryValidations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category.data - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category.data.type - in: query - description: Validations:Must be one of:password-categories. - required: true - schema: - type: string - - name: data.relationships.password_category.data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.relationships.password_category.data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.relationships.password_category.data.attributes.account_id - in: query - description: Identifies the account that this category belongs to.Validations:Must - be a number. - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /organizations/{organization_id}/relationships/passwords/{id}: - get: - summary: '' - description: Returns the details of an existing password. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - - name: show_password - in: query - description: 'defaults to ''true'', Can be set to ''false'' to not return - the passwordValidations:Must be one of:true,false.Metadata:Param Type: In - URL' - required: false - schema: - type: string - - name: version_id - in: query - description: 'Set the password''s version ID to return it''s revisionValidations:Must - be a number.Metadata:Param Type: In URL' - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified passwords. Returns the deleted passwords - and a 200 status code if successful. - parameters: - - name: organization_id - in: path - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: id - in: path - description: '' - required: true - schema: - type: string - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cpasswordsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:passwords. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.cached_resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /password_categories: - get: - summary: '' - description: Returns a list of password categories in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a new password category in your account. Returns the created - object if successful. - parameters: - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:password_categories. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /password_categories/{id}: - get: - summary: '' - description: Returns the details of an existing password category. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /passwords: - get: - summary: '' - description: Returns a list of passwords for all organizations or for a specified - organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.cached_resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - post: - summary: '' - description: Creates a password under the organization specified in the ID parameter. - Returns the created object if successful. Use the nested relationships route - to add multiple passwords to an organization in bulk. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: show_password - in: query - description: 'defaults to ''false'', Can be set to ''true'' to return the - passwordValidations:Must be one of:true,false.Metadata:Param Type: In URL' - required: false - schema: - type: string - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:passwords. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: Required identifier for bulk updatesValidations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.organization_id - in: query - description: Not required when using nested relationship routesValidations:Must - be a number. - required: true - schema: - type: integer - - name: data.attributes.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.username - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.password - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.otp_secret - in: query - description: One Time Password secretValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.resource_id - in: query - description: Must be used together with `resource_type`Validations:Must be - a number. - required: false - schema: - type: integer - - name: data.attributes.resource_type - in: query - description: Must be used together with `resource_id`Validations:Must be one - of:Configuration,Contact,Document,Domain,Location,SSL Certificate,Flexible - Asset,Ticket. - required: false - schema: - type: string - - name: data.attributes.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.password_updated_at - in: query - description: Date the password last changedValidations:Must be a String - required: false - schema: - type: string - - name: data.attributes.restricted - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.autofill_selectors - in: query - description: Used for identification of fields for password autofillValidations:Must - be a String - required: false - schema: - type: string - - name: data.attributes.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.is_live - in: query - description: Used for understanding - is this a live version of the password - or not.Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - - name: data.attributes.generated_password_type - in: query - description: This value indicates if the user is using the complex password - feature, and if the password is complex or pronounceable.Validations:Must - be a String - required: false - schema: - type: string - - name: data.relationships - in: query - description: Not permitted in PUT/PATCH, optional in POSTValidations:Must - be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category - in: query - description: Can belong to one password categoryValidations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category.data - in: query - description: Validations:Must be a Hash - required: false - schema: - type: object - - name: data.relationships.password_category.data.type - in: query - description: Validations:Must be one of:password-categories. - required: true - schema: - type: string - - name: data.relationships.password_category.data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.relationships.password_category.data.attributes.name - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.relationships.password_category.data.attributes.account_id - in: query - description: Identifies the account that this category belongs to.Validations:Must - be a number. - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified passwords. Returns the deleted passwords - and a 200 status code if successful. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cpasswordsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:passwords. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.password_category_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.url - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.cached_resource_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.archived - in: query - description: Validations:Must be one of:true,false,1,0. - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /passwords/{id}: - get: - summary: '' - description: Returns the details of an existing password. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: organization_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - - Notes: Must be a valid Organization Id in your Account' - required: true - schema: - type: integer - - name: include - in: query - description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param - Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: string - - name: show_password - in: query - description: 'defaults to ''true'', Can be set to ''false'' to not return - the passwordValidations:Must be one of:true,false.Metadata:Param Type: In - URL' - required: false - schema: - type: string - - name: version_id - in: query - description: 'Set the password''s version ID to return it''s revisionValidations:Must - be a number.Metadata:Param Type: In URL' - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Destroys a single password with its ID. Returns a 204 status code - if successful. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /platforms: - get: - summary: '' - description: Returns a list of supported platforms. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /platforms/{id}: - get: - summary: '' - description: Returns details of one of the supported platforms. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /regions: - get: - summary: '' - description: Returns a list of supported regions. - parameters: - - name: country_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid country ID.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: filter.iso - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.country_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /regions/{id}: - get: - summary: '' - description: Returns the details of one of the supported regions. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: country_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - - :Notes: Must be a valid country ID.' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /user_metrics: - get: - summary: '' - description: Returns a list of the user metrics in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.user_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.organization_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.resource_type - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.date - in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String - required: false - schema: - type: string - - name: sort - in: query - description: "Validations:Must be one of:id,created,viewed,edited,deleted,date.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /users: - get: - summary: '' - description: Returns a list of the users in your account. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: exact match onlyValidations:Must be a String - required: false - schema: - type: string - - name: filter.email - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.role_name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.salesforce_id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,email,reputation,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false - schema: - type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - security: - - apiKeyAuth: [] - /users/{id}: - get: - summary: '' - description: Returns information about one user. - parameters: - - name: id - in: path - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '404': - description: Not Found - security: - - apiKeyAuth: [] - /{resource_type}/{resource_id}/relationships/attachments: - post: - summary: '' - description: Attaches a file to the asset specified in the ID parameter. Returns the - created object if successful. Can also be used to add multiple attachments - to an asset in bulk. - parameters: - - name: resource_type - in: path - description: 'The resource type of the parent resourceValidations:Must be - one of:checklists,checklist_templates,configurations,contacts,documents,domains,locations,passwords,ssl_certificates,flexible_assets,tickets.Metadata:Param - Type: In URL' - required: true - schema: - type: string - - name: resource_id - in: path - description: 'The resource id of the parent resource.Validations:Must be a - number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:attachments. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.attachment - in: query - description: "Can be an uploaded file if multipart is used, or a JSON with\ - \ Base64 encoded content as following:\"attachment\"\ - : {\n \"content\": \"\",\n \"file_name\"\ - : \"test.png\"\n}Validations:Must be one of:Hash,File." - required: true - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified attachments. Returns the deleted - attachments and a 200 status code if successful. - parameters: - - name: resource_type - in: path - description: 'The resource type of the parent resourceValidations:Must be - one of:checklists,checklist_templates,configurations,contacts,documents,domains,locations,passwords,ssl_certificates,flexible_assets,tickets.Metadata:Param - Type: In URL' - required: true - schema: - type: string - - name: resource_id - in: path - description: 'The resource id of the parent resource.Validations:Must be a - number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Cattachmentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:attachments. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - /{resource_type}/{resource_id}/relationships/related_items: - post: - summary: '' - description: Creates a related item. Returns the created object if successful. Can - also be used to add multiple related items to an asset in bulk. - parameters: - - name: resource_type - in: path - description: 'The resource type of the parent resourceValidations:Must be - one of:checklists,checklist_templates,configurations,contacts,documents,domains,folders,locations,passwords,ssl_certificates,flexible_assets,tickets.Metadata:Param - Type: In URL' - required: true - schema: - type: string - - name: resource_id - in: path - description: 'The resource id of the parent resource.Validations:Must be a - number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be a HashMetadata:Param Type: JSON Body Param' - required: true - schema: - type: object - - name: data.type - in: query - description: Validations:Must be one of:related_items. - required: true - schema: - type: string - - name: data.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data.attributes.id - in: query - description: 'Validations:Must be a number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: data.attributes.destination_type - in: query - description: Validations:Must be one of:User,Checklist,Checklist Template,Contact,Configuration,Datto - Device,Document,Document Folder,Domain,Location,Organization,Password,SSL - Certificate,Flexible Asset,Ticket. - required: true - schema: - type: string - - name: data.attributes.destination_id - in: query - description: Validations:Must be a String - required: true - schema: - type: string - - name: data.attributes.notes - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: data.attributes.via_copilot - in: query - description: Validations:Must be a String - required: false - schema: - type: string - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] - delete: - summary: '' - description: Deletes one or more specified related items. Returns the deleted - related items and a 200 status code if successful. - parameters: - - name: resource_type - in: path - description: 'The resource type of the parent resourceValidations:Must be - one of:checklists,checklist_templates,configurations,contacts,documents,domains,folders,locations,passwords,ssl_certificates,flexible_assets,tickets.Metadata:Param - Type: In URL' - required: true - schema: - type: string - - name: resource_id - in: path - description: 'The resource id of the parent resource.Validations:Must be a - number.Metadata:Param Type: In URL' - required: true - schema: - type: integer - - name: data - in: query - description: 'Validations:Must be an Array of nested elementsMetadata:Param - Type: JSON Body Param - - Notes: Cannot be used in combination with filter' - required: true - schema: - type: string - - name: data._ - in: query - description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ - \x9Crelated_itemsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ - \ be a Hash" - required: false - schema: - type: object - - name: data._.type - in: query - description: Validations:Must be one of:related_items. - required: true - schema: - type: string - - name: data._.attributes - in: query - description: Validations:Must be a Hash - required: true - schema: - type: object - - name: data._.attributes.id - in: query - description: Validations:Must be a number. - required: true - schema: - type: integer - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - '401': - description: Unauthorized - '400': - description: Bad Request - '404': - description: Not Found - '415': - description: Unsupported Media Type - '422': - description: Unprocessable Entity - security: - - apiKeyAuth: [] -components: - schemas: {} - securitySchemes: - apiKeyAuth: - type: apiKey - in: header - name: x-api-key -security: -- apiKeyAuth: [] - diff --git a/itgapi.yaml b/itgapi.yaml index a95fbd3..a5569fc 100644 --- a/itgapi.yaml +++ b/itgapi.yaml @@ -46,56 +46,56 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configuration_interfaces. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.configuration_id + - name: data[attributes][configuration_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.ip_address + - name: data[attributes][ip_address] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.attributes.mac_address + - name: data[attributes][mac_address] in: query description: Must be a valid MAC addressValidations:Must be a String required: false schema: type: string - - name: data.attributes.primary + - name: data[attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false @@ -123,7 +123,11 @@ paths: /configuration_interfaces/{id}: get: summary: '' - description: Returns the details of an existing configuration interface. + description: 'Returns the details of an existing configuration interface. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -131,6 +135,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: configuration_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -156,22 +181,26 @@ paths: /configuration_statuses: get: summary: '' - description: Returns a list of the configuration statuses in your account. + description: 'Returns a list of the configuration statuses in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -180,24 +209,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -220,19 +251,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configuration_statuses. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -258,7 +289,11 @@ paths: /configuration_statuses/{id}: get: summary: '' - description: Returns the details of an existing configuration status. + description: 'Returns the details of an existing configuration status. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -266,6 +301,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -282,22 +338,26 @@ paths: /configuration_types: get: summary: '' - description: Returns a list of configuration types in your account. + description: 'Returns a list of configuration types in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -306,24 +366,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -346,19 +408,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configuration_types. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -384,7 +446,11 @@ paths: /configuration_types/{id}: get: summary: '' - description: Returns the details of an existing configuration type. + description: 'Returns the details of an existing configuration type. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -392,6 +458,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -408,9 +495,53 @@ paths: /configurations: get: summary: '' - description: Returns a list of configurations for all organizations or for a - specified organization. + description: 'Returns a list of configurations for all organizations or for + a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string + - name: filter[name] + in: query + description: Validations:Must be a String + required: false + schema: + type: string + - name: filter[status] + in: query + description: Filter results by status + required: false + schema: + type: string + - name: filter[organization_id] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -428,118 +559,86 @@ paths: required: false schema: type: object - - name: filter.id - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String - required: false - schema: - type: string - - name: filter.organization_id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_type_id + - name: filter[configuration_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_status_id + - name: filter[configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.contact_id + - name: filter[contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.serial_number + - name: filter[serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.mac_address + - name: filter[mac_address] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.asset_tag + - name: filter[asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.rmm_id + - name: filter[rmm_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for rmm_integration_type' required: false schema: type: string - - name: filter.rmm_integration_type + - name: filter[rmm_integration_type] in: query description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,passwords,attachments,tickets,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -581,208 +680,208 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configurations. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.configuration_type_id + - name: data[attributes][configuration_type_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.configuration_status_id + - name: data[attributes][configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.location_id + - name: data[attributes][location_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.contact_id + - name: data[attributes][contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.manufacturer_id + - name: data[attributes][manufacturer_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.model_id + - name: data[attributes][model_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.operating_system_id + - name: data[attributes][operating_system_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.operating_system_notes + - name: data[attributes][operating_system_notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.hostname + - name: data[attributes][hostname] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.primary_ip + - name: data[attributes][primary_ip] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.attributes.mac_address + - name: data[attributes][mac_address] in: query description: 17 Character limitValidations:Must be a String required: false schema: type: string - - name: data.attributes.default_gateway + - name: data[attributes][default_gateway] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.serial_number + - name: data[attributes][serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.asset_tag + - name: data[attributes][asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.position + - name: data[attributes][position] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.installed_by + - name: data[attributes][installed_by] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.purchased_by + - name: data[attributes][purchased_by] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.purchased_at + - name: data[attributes][purchased_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.warranty_expires_at + - name: data[attributes][warranty_expires_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.mitp_device_expiration_date + - name: data[attributes][mitp_device_expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.mitp_end_of_life_date + - name: data[attributes][mitp_end_of_life_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.installed_at + - name: data[attributes][installed_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships + - name: data[relationships] in: query description: Not permitted in PUT/PATCH, optional in POSTValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces + - name: data[relationships][configuration_interfaces] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces.data + - name: data[relationships][configuration_interfaces][data] in: query description: Can contain multiple InterfacesValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._ + - name: data[relationships][configuration_interfaces][data][_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cconfiguration_interfacesâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80\ @@ -790,43 +889,43 @@ paths: required: false schema: type: object - - name: data.relationships.configuration_interfaces.data._.type + - name: data[relationships][configuration_interfaces][data][_][type] in: query description: Validations:Must be one of:configuration_interfaces. required: true schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes + - name: data[relationships][configuration_interfaces][data][_][attributes] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces.data._.attributes.name + - name: data[relationships][configuration_interfaces][data][_][attributes][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.ip_address + - name: data[relationships][configuration_interfaces][data][_][attributes][ip_address] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.mac_address + - name: data[relationships][configuration_interfaces][data][_][attributes][mac_address] in: query description: Must be a valid MAC addressValidations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.primary + - name: data[relationships][configuration_interfaces][data][_][attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.notes + - name: data[relationships][configuration_interfaces][data][_][attributes][notes] in: query description: Validations:Must be a String required: false @@ -863,7 +962,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cconfigurationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -871,19 +970,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:configurations. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -897,87 +996,87 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_type_id + - name: filter[configuration_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_status_id + - name: filter[configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.contact_id + - name: filter[contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.serial_number + - name: filter[serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.mac_address + - name: filter[mac_address] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.asset_tag + - name: filter[asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.rmm_id + - name: filter[rmm_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for rmm_integration_type' required: false schema: type: string - - name: filter.rmm_integration_type + - name: filter[rmm_integration_type] in: query description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -1005,7 +1104,11 @@ paths: /configurations/{configuration_id}/relationships/configuration_interfaces: get: summary: '' - description: Returns the configuration interfaces for a specified configuration. + description: 'Returns the configuration interfaces for a specified configuration. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: configuration_id in: path @@ -1016,26 +1119,20 @@ paths: required: true schema: type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id + - name: page[size] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.ip_address + maximum: 1000 + - name: page[number] in: query - description: Validations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ @@ -1044,24 +1141,32 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: filter[ip_address] in: query - description: Validations:Must be a number. + description: Validations:Must be a String required: false schema: - type: integer + type: string + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object responses: '200': description: Successful response @@ -1097,56 +1202,56 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configuration_interfaces. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.configuration_id + - name: data[attributes][configuration_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.ip_address + - name: data[attributes][ip_address] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.attributes.mac_address + - name: data[attributes][mac_address] in: query description: Must be a valid MAC addressValidations:Must be a String required: false schema: type: string - - name: data.attributes.primary + - name: data[attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false @@ -1174,7 +1279,11 @@ paths: /configurations/{configuration_id}/relationships/configuration_interfaces/{id}: get: summary: '' - description: Returns the details of an existing configuration interface. + description: 'Returns the details of an existing configuration interface. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: configuration_id in: path @@ -1191,6 +1300,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -1207,7 +1337,11 @@ paths: /configurations/{id}: get: summary: '' - description: Returns the details of an existing configuration. + description: 'Returns the details of an existing configuration. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -1215,6 +1349,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -1249,22 +1404,26 @@ paths: /contact_types: get: summary: '' - description: Returns a list of contact types in your account. + description: 'Returns a list of contact types in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -1273,24 +1432,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -1313,19 +1474,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:contact_types. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -1351,7 +1512,11 @@ paths: /contact_types/{id}: get: summary: '' - description: Returns the details of an existing contact type. + description: 'Returns the details of an existing contact type. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -1359,9 +1524,30 @@ paths: required: true schema: type: integer - responses: - '200': - description: Successful response + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string + responses: + '200': + description: Successful response content: application/json: schema: @@ -1375,9 +1561,35 @@ paths: /contacts: get: summary: '' - description: Returns a list of contacts for all organizations or for a specified + description: 'Returns a list of contacts for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -1395,93 +1607,73 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.first_name + - name: filter[first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.last_name + - name: filter[last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.title + - name: filter[title] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.contact_type_id + - name: filter[contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.important + - name: filter[important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: filter.primary_email + - name: filter[primary_email] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -1524,87 +1716,87 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:contacts. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.contact_type_id + - name: data[attributes][contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.location_id + - name: data[attributes][location_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.first_name + - name: data[attributes][first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.last_name + - name: data[attributes][last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.title + - name: data[attributes][title] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.important + - name: data[attributes][important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.contact_emails + - name: data[contact_emails] in: query description: Can contain multiple emailsValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.contact_emails._ + - name: data[contact_emails][_] in: query description: "Nameless hash, should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ \x9Cemail@company.comâ\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ @@ -1612,32 +1804,32 @@ paths: required: false schema: type: object - - name: data.contact_emails._.value + - name: data[contact_emails][_][value] in: query description: Must be a valid email address formatValidations:Must be a String required: true schema: type: string - - name: data.contact_emails._.label_name + - name: data[contact_emails][_][label_name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.contact_emails._.primary + - name: data[contact_emails][_][primary] in: query description: Defaults to false if not provided.Validations:Must be one of:true,false. required: false schema: type: string - - name: data.contact_phones + - name: data[contact_phones] in: query description: Can contain multiple phonesValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.contact_phones._ + - name: data[contact_phones][_] in: query description: "Nameless hash: should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ \x9C2341112233â\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ @@ -1645,33 +1837,33 @@ paths: required: false schema: type: object - - name: data.contact_phones._.value + - name: data[contact_phones][_][value] in: query description: Phone numbers are stripped of all separators.Validations:Must be a String required: true schema: type: string - - name: data.contact_phones._.label_name + - name: data[contact_phones][_][label_name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.contact_phones._.extension + - name: data[contact_phones][_][extension] in: query description: Phone extensions are stripped of all separators.Validations:Must be a String required: false schema: type: string - - name: data.contact_phones._.primary + - name: data[contact_phones][_][primary] in: query description: Defaults to false if not provided.Validations:Must be one of:true,false. required: false schema: type: string - - name: data.contact_phones._.label_type + - name: data[contact_phones][_][label_type] in: query description: Defaults to phone if not provided.Validations:Must be one of:phone,fax. required: false @@ -1719,7 +1911,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Ccontactsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -1727,19 +1919,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:contacts. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -1753,62 +1945,62 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.first_name + - name: filter[first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.last_name + - name: filter[last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.title + - name: filter[title] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.contact_type_id + - name: filter[contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.important + - name: filter[important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: filter.primary_email + - name: filter[primary_email] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false @@ -1836,7 +2028,11 @@ paths: /contacts/{id}: get: summary: '' - description: Returns the details of an existing contact. + description: 'Returns the details of an existing contact. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -1844,6 +2040,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -1878,28 +2095,41 @@ paths: /copilot_smart_assist/documents: get: summary: '' - description: Offer analytics on documentation usage, such as 'Documents not - viewed in X amount of time', 'Documents that were never viewed', 'Documents - that are expired', and 'Duplicate documents'. + description: 'Offer analytics on documentation usage, such as ''Documents not + viewed in X amount of time'', ''Documents that were never viewed'', ''Documents + that are expired'', and ''Duplicate documents''. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: page + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: Validations:Must be a number. required: false schema: - type: object - - name: page.number + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + minimum: 1 + - name: sort in: query - description: Validations:Must be a number. + description: Field by which to sort the results. Prepend '-' for descending + order. required: false schema: - type: integer + type: string + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -1908,13 +2138,13 @@ paths: required: false schema: type: object - - name: filter.type + - name: filter[type] in: query description: Validations:Must be one of:stale,not_viewed,expired. required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false @@ -1948,7 +2178,7 @@ paths: required: false schema: type: object - - name: filter.type + - name: filter[type] in: query description: Validations:Must be one of:stale,not_viewed,expired. required: false @@ -1963,7 +2193,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cdocumentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -1971,25 +2201,25 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:documents. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data._.attributes.archived + - name: data[_][attributes][archived] in: query description: Validations:Must be one of:true,false. required: true @@ -2007,28 +2237,26 @@ paths: /countries: get: summary: '' - description: Returns a list of supported countries. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI + description: 'Returns a list of supported countries. - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.name + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' + parameters: + - name: page[size] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string - - name: filter.iso + type: integer + maximum: 1000 + - name: page[number] in: query - description: Validations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -2037,24 +2265,32 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: filter[iso] in: query - description: Validations:Must be a number. + description: Validations:Must be a String required: false schema: - type: integer + type: string + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object responses: '200': description: Successful response @@ -2069,7 +2305,11 @@ paths: /countries/{country_id}/relationships/regions: get: summary: '' - description: Returns a list of supported regions. + description: 'Returns a list of supported regions. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: country_id in: path @@ -2080,6 +2320,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -2088,50 +2350,30 @@ paths: required: false schema: type: object - - name: filter.name + - name: filter[name] in: query description: exact match onlyValidations:Must be a String required: false schema: type: string - - name: filter.iso + - name: filter[iso] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -2146,7 +2388,11 @@ paths: /countries/{country_id}/relationships/regions/{id}: get: summary: '' - description: Returns the details of one of the supported regions. + description: 'Returns the details of one of the supported regions. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: country_id in: path @@ -2163,6 +2409,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -2179,7 +2446,11 @@ paths: /countries/{id}: get: summary: '' - description: Returns the details of one of the supported countries. + description: 'Returns the details of one of the supported countries. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -2187,6 +2458,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -2203,38 +2495,27 @@ paths: /domains: get: summary: '' - description: Returns a list of domains for all organizations or for a specified + description: 'Returns a list of domains for all organizations or for a specified organization. - parameters: - - name: organization_id - in: query - description: 'Only required for nested relationships route.Validations:Must - be a number.Metadata:Param Type: In URL - Notes: Must be a valid organization ID in your account.' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' + parameters: + - name: page[size] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ @@ -2243,24 +2524,41 @@ paths: required: false schema: type: string - - name: page + - name: organization_id in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Only required for nested relationships route.Validations:Must + be a number.Metadata:Param Type: In URL + + Notes: Must be a valid organization ID in your account.' + required: true + schema: + type: integer + - name: filter + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object - name: include in: query description: 'Validations:Must be one of:passwords,attachments,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -2284,9 +2582,35 @@ paths: /expirations: get: summary: '' - description: Returns a list of expirations for all organizations or for a specified + description: 'Returns a list of expirations for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -2304,49 +2628,49 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.resource_id + - name: filter[resource_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.resource_name + - name: filter[resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.resource_type_name + - name: filter[resource_type_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.description + - name: filter[description] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.expiration_date + - name: filter[expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.range + - name: filter[range] in: query description: "To filter on a specific range, supply two comma-separated values\ \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ @@ -2357,38 +2681,18 @@ paths: required: false schema: type: object - - name: filter.range.expiration_date + - name: filter[range][expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: sort + - name: page in: query - description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - - name: page - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -2403,8 +2707,12 @@ paths: /expirations/{id}: get: summary: '' - description: Returns a single expiration with the given ID or a single expiration + description: 'Returns a single expiration with the given ID or a single expiration for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -2412,6 +2720,27 @@ paths: required: true schema: type: string + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -2437,22 +2766,26 @@ paths: /exports: get: summary: '' - description: Returns a list of exports in your account. + description: 'Returns a list of exports in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.id + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ @@ -2461,24 +2794,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -2509,19 +2844,19 @@ paths: required: true schema: type: object - - name: attributes.organization_id + - name: attributes[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: attributes.include_logs + - name: attributes[include_logs] in: query description: Defaults to false if not providedValidations:Must be one of:true,false,1,0. required: false schema: type: string - - name: attributes.zip_password + - name: attributes[zip_password] in: query description: Validations:Must be a String required: false @@ -2547,7 +2882,11 @@ paths: /exports/{id}: get: summary: '' - description: '''Retrieve a particular export for current account.''' + description: '''Retrieve a particular export for current account.'' + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -2555,6 +2894,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of: .Metadata:Param Type: CGI @@ -2602,8 +2962,34 @@ paths: /flexible_asset_types: get: summary: '' - description: Returns a list of flexible asset types in your account. + description: 'Returns a list of flexible asset types in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:id,name,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -2612,56 +2998,36 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.icon + - name: filter[icon] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.enabled + - name: filter[enabled] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:id,name,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:flexible_asset_fields.Metadata:Param @@ -2694,49 +3060,49 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:flexible_asset_types. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.description + - name: data[attributes][description] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.icon + - name: data[attributes][icon] in: query description: icon image nameValidations:Must be a String required: false schema: type: string - - name: data.attributes.enabled + - name: data[attributes][enabled] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.fields + - name: data[attributes][fields] in: query description: List of fields for this flexible asset type; each flexible asset type must have at least one field and at least one field with show_in_list @@ -2744,65 +3110,65 @@ paths: required: true schema: type: string - - name: data.attributes.fields.id + - name: data[attributes][fields][id] in: query description: Required identifier for updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.fields.flexible_asset_type_id + - name: data[attributes][fields][flexible_asset_type_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.fields.order + - name: data[attributes][fields][order] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.fields.name + - name: data[attributes][fields][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.fields.kind + - name: data[attributes][fields][kind] in: query description: Kind cannot be changed once there are traits created for the fieldValidations:Must be one of:Checkbox,Date,Header,Number,Select,Text,Textbox,Upload,Tag,Percent,Password. required: true schema: type: string - - name: data.attributes.fields.hint + - name: data[attributes][fields][hint] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.fields.decimals + - name: data[attributes][fields][decimals] in: query description: A non-negative required value if field type is Number or PercentValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.fields.default_value + - name: data[attributes][fields][default_value] in: query description: Required if field type is SelectValidations:Must be a String required: false schema: type: string - - name: data.attributes.fields.tag_type + - name: data[attributes][fields][tag_type] in: query description: 'Validations:Must be one of:AccountsUsers,Checklists,ChecklistTemplates,Contacts,Configurations,Documents,Domains,Passwords,Locations,Organizations,SslCertificates,Tickets,FlexibleAssetType: id.' required: false schema: type: string - - name: data.attributes.fields.required + - name: data[attributes][fields][required] in: query description: Indicates if the field is required for the flexible asset; it will be set to false if the field type is HeaderValidations:Must be one @@ -2810,7 +3176,7 @@ paths: required: false schema: type: string - - name: data.attributes.fields.use_for_title + - name: data[attributes][fields][use_for_title] in: query description: 'Indicates if the field name should be added to the flexible asset name; it will be set to false if the field type is one of: Checkbox, @@ -2819,39 +3185,39 @@ paths: required: false schema: type: string - - name: data.attributes.fields.expiration + - name: data[attributes][fields][expiration] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.fields.show_in_list + - name: data[attributes][fields][show_in_list] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships + - name: data[relationships] in: query description: Not permitted in PUT/PATCH, optional in POSTValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.flexible_asset_fields + - name: data[relationships][flexible_asset_fields] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.flexible_asset_fields.data + - name: data[relationships][flexible_asset_fields][data] in: query description: Can contain multiple Flexible Asset FieldsValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._ + - name: data[relationships][flexible_asset_fields][data][_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cflexible_asset_fieldsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80¦}Validations:Must\ @@ -2859,64 +3225,64 @@ paths: required: false schema: type: object - - name: data.relationships.flexible_asset_fields.data._.type + - name: data[relationships][flexible_asset_fields][data][_][type] in: query description: Validations:Must be one of:flexible_asset_fields. required: true schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes + - name: data[relationships][flexible_asset_fields][data][_][attributes] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.flexible_asset_fields.data._.attributes.order + - name: data[relationships][flexible_asset_fields][data][_][attributes][order] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.relationships.flexible_asset_fields.data._.attributes.name + - name: data[relationships][flexible_asset_fields][data][_][attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.kind + - name: data[relationships][flexible_asset_fields][data][_][attributes][kind] in: query description: Kind cannot be changed once there are traits created for the fieldValidations:Must be one of:Checkbox,Date,Header,Number,Select,Text,Textbox,Upload,Tag,Percent,Password. required: true schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.hint + - name: data[relationships][flexible_asset_fields][data][_][attributes][hint] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.decimals + - name: data[relationships][flexible_asset_fields][data][_][attributes][decimals] in: query description: A non-negative required value if field type is Number or PercentValidations:Must be a number. required: false schema: type: integer - - name: data.relationships.flexible_asset_fields.data._.attributes.default_value + - name: data[relationships][flexible_asset_fields][data][_][attributes][default_value] in: query description: Required if field type is SelectValidations:Must be a String required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.tag_type + - name: data[relationships][flexible_asset_fields][data][_][attributes][tag_type] in: query description: 'Validations:Must be one of:AccountsUsers,Checklists,ChecklistTemplates,Contacts,Configurations,Documents,Domains,Passwords,Locations,Organizations,SslCertificates,Tickets,FlexibleAssetType: id.' required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.required + - name: data[relationships][flexible_asset_fields][data][_][attributes][required] in: query description: Indicates if the field is required for the flexible asset; it will be set to false if the field type is HeaderValidations:Must be one @@ -2924,7 +3290,7 @@ paths: required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.use_for_title + - name: data[relationships][flexible_asset_fields][data][_][attributes][use_for_title] in: query description: 'Indicates if the field name should be added to the flexible asset name; it will be set to false if the field type is one of: Checkbox, @@ -2933,13 +3299,13 @@ paths: required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.expiration + - name: data[relationships][flexible_asset_fields][data][_][attributes][expiration] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships.flexible_asset_fields.data._.attributes.show_in_list + - name: data[relationships][flexible_asset_fields][data][_][attributes][show_in_list] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -2963,7 +3329,11 @@ paths: /flexible_asset_types/{id}: get: summary: '' - description: Returns the details of an existing flexible asset type. + description: 'Returns the details of an existing flexible asset type. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -2971,6 +3341,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:flexible_asset_fields.Metadata:Param @@ -2996,35 +3387,27 @@ paths: /flexible_assets: get: summary: '' - description: Returns a list of flexible assets based on the unique ID of the + description: 'Returns a list of flexible assets based on the unique ID of the flexible asset type. - parameters: - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - Description: All filter params have to be exact match only' - required: true - schema: - type: object - - name: filter.flexible-asset-type-id + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' + parameters: + - name: page[size] in: query description: Validations:Must be a number. - required: true - schema: - type: integer - - name: filter.name - in: query - description: Validations:Must be a String required: false schema: - type: string - - name: filter.organization-id + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ @@ -3033,24 +3416,38 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' - required: false + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Description: All filter params have to be exact match only' + required: true schema: type: object - - name: page.number + - name: filter[flexible-asset-type-id] in: query description: Validations:Must be a number. - required: false + required: true schema: type: integer - - name: page.size + - name: filter[name] + in: query + description: Validations:Must be a String + required: false + schema: + type: string + - name: filter[organization-id] in: query description: Validations:Must be a number. required: false schema: type: integer + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object - name: include in: query description: 'Validations:Must be one of:adapters_resources,distinct_remote_assets,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -3081,43 +3478,43 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:flexible_assets. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.flexible_asset_type_id + - name: data[attributes][flexible_asset_type_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.traits + - name: data[attributes][traits] in: query description: A hash of key value pairs for the traits of this asset. Values can be arrays. The key has to be an available field key from the specified @@ -3158,7 +3555,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cflexible_assetsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -3166,19 +3563,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:flexible_assets. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -3192,25 +3589,25 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: exact match onlyValidations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: filter.flexible_asset_type_id + - name: filter[flexible_asset_type_id] in: query description: Validations:Must be a number. required: true @@ -3236,7 +3633,11 @@ paths: /flexible_assets/{id}: get: summary: '' - description: Returns the details of an existing flexible asset. + description: 'Returns the details of an existing flexible asset. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -3244,6 +3645,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:adapters_resources,distinct_remote_assets,attachments,passwords,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param @@ -3293,22 +3715,26 @@ paths: /groups: get: summary: '' - description: Returns a list of groups in your account. + description: 'Returns a list of groups in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ @@ -3317,24 +3743,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object - name: include in: query description: 'Validations:Must be one of:users.Metadata:Param Type: CGI @@ -3357,7 +3785,11 @@ paths: /groups/{id}: get: summary: '' - description: Returns the details of an existing group. + description: 'Returns the details of an existing group. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -3365,6 +3797,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:users.Metadata:Param Type: CGI @@ -3389,9 +3842,35 @@ paths: /locations: get: summary: '' - description: Returns a list of locations for all organizations or for a specified + description: 'Returns a list of locations for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -3409,81 +3888,61 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.city + - name: filter[city] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.region_id + - name: filter[region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -3528,98 +3987,98 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:locations. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.primary + - name: data[attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.address_1 + - name: data[attributes][address_1] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.address_2 + - name: data[attributes][address_2] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.city + - name: data[attributes][city] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.postal_code + - name: data[attributes][postal_code] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.region_id + - name: data[attributes][region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.country_id + - name: data[attributes][country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.phone + - name: data[attributes][phone] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.fax + - name: data[attributes][fax] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -3658,7 +4117,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Clocationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -3666,19 +4125,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:locations. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -3692,50 +4151,50 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.city + - name: filter[city] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.region_id + - name: filter[region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false @@ -3763,7 +4222,11 @@ paths: /locations/{id}: get: summary: '' - description: Returns the details of an existing location. + description: 'Returns the details of an existing location. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -3771,7 +4234,28 @@ paths: required: true schema: type: integer - - name: organization_id + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string + - name: organization_id in: query description: 'Only required for nested relationships route.Validations:Must be a number.Metadata:Param Type: In URL @@ -3805,25 +4289,27 @@ paths: /logs: get: summary: '' - description: Get all activity logs of the account for most recent 30 days. + description: 'Get all activity logs of the account for most recent 30 days. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.created_at + type: integer + maximum: 1000 + - name: page[number] in: query - description: The specified string must be a date range and comma-separated - as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` - or `end_date`. Date ranges longer than a week may be disallowed for performance - reasons.Validations:Must be a String + description: 'Validations:Must be a number.Metadata:Notes: Must be a value + between 1 and 5 (inclusive).' required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:created_at.Metadata:Param Type: CGI\n\ @@ -3831,25 +4317,29 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[created_at] in: query - description: 'Validations:Must be a number.Metadata:Notes: Must be a value - between 1 and 5 (inclusive).' + description: The specified string must be a date range and comma-separated + as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` + or `end_date`. Date ranges longer than a week may be disallowed for performance + reasons.Validations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -3864,22 +4354,26 @@ paths: /manufacturers: get: summary: '' - description: Returns a list of the manufacturer names in your account. + description: 'Returns a list of the manufacturer names in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -3888,24 +4382,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -3928,19 +4424,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:manufacturers. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -3966,7 +4462,11 @@ paths: /manufacturers/{id}: get: summary: '' - description: Returns the details of an existing manufacturer name. + description: 'Returns the details of an existing manufacturer name. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -3974,6 +4474,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -3990,8 +4511,12 @@ paths: /manufacturers/{manufacturer_id}/relationships/models: get: summary: '' - description: Returns a list of model names for all manufacturers or for a specified + description: 'Returns a list of model names for all manufacturers or for a specified manufacturer. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: manufacturer_id in: path @@ -4002,20 +4527,20 @@ paths: required: true schema: type: integer - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.id + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:id,name,manufacturer_id,created_at,updated_at.Metadata:Param\ @@ -4024,24 +4549,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -4076,32 +4603,32 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:models. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.manufacturer_id + - name: data[attributes][manufacturer_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -4129,7 +4656,11 @@ paths: /manufacturers/{manufacturer_id}/relationships/models/{id}: get: summary: '' - description: Returns the details of an existing model name. + description: 'Returns the details of an existing model name. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: manufacturer_id in: path @@ -4146,6 +4677,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -4162,32 +4714,27 @@ paths: /models: get: summary: '' - description: Returns a list of model names for all manufacturers or for a specified + description: 'Returns a list of model names for all manufacturers or for a specified manufacturer. - parameters: - - name: manufacturer_id - in: query - description: 'Only required for nested relationships routeValidations:Must - be a number.Metadata:Param Type: In URL - :Notes: Must be a valid Manufacturer Id in your Account' - required: true - schema: - type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - Notes: Comma separated values' + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' + parameters: + - name: page[size] + in: query + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.id + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:id,name,manufacturer_id,created_at,updated_at.Metadata:Param\ @@ -4196,24 +4743,35 @@ paths: required: false schema: type: string - - name: page + - name: manufacturer_id in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Only required for nested relationships routeValidations:Must + be a number.Metadata:Param Type: In URL + + :Notes: Must be a valid Manufacturer Id in your Account' + required: true + schema: + type: integer + - name: filter + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -4248,32 +4806,32 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:models. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.manufacturer_id + - name: data[attributes][manufacturer_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -4301,7 +4859,11 @@ paths: /models/{id}: get: summary: '' - description: Returns the details of an existing model name. + description: 'Returns the details of an existing model name. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -4309,6 +4871,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: manufacturer_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -4334,22 +4917,26 @@ paths: /operating_systems: get: summary: '' - description: Returns a list of supported operating systems. + description: 'Returns a list of supported operating systems. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -4358,24 +4945,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -4390,7 +4979,11 @@ paths: /operating_systems/{id}: get: summary: '' - description: Returns the details of one of the supported operating systems. + description: 'Returns the details of one of the supported operating systems. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -4398,6 +4991,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -4414,22 +5028,26 @@ paths: /organization_statuses: get: summary: '' - description: Returns a list of the organization statuses in your account. + description: 'Returns a list of the organization statuses in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -4438,24 +5056,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -4478,19 +5098,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:organization_statuses. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -4516,7 +5136,11 @@ paths: /organization_statuses/{id}: get: summary: '' - description: Returns the details of an existing organization status. + description: 'Returns the details of an existing organization status. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -4524,6 +5148,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -4540,22 +5185,26 @@ paths: /organization_types: get: summary: '' - description: Returns a list of organization types in your account. + description: 'Returns a list of organization types in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -4564,24 +5213,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -4604,19 +5255,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:organization_types. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -4642,7 +5293,11 @@ paths: /organization_types/{id}: get: summary: '' - description: Returns the details of an existing organization type. + description: 'Returns the details of an existing organization type. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -4650,6 +5305,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -4666,41 +5342,73 @@ paths: /organizations: get: summary: '' - description: Returns a list of organizations in your account. + description: 'Returns a list of organizations in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.id + type: integer + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,updated_at,organization_status_name,organization_type_name,created_at,short_name,my_glue_account_id.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_type_id + - name: filter[status] + in: query + description: Filter results by status + required: false + schema: + type: string + - name: filter + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' + required: false + schema: + type: object + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_status_id + - name: filter[organization_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.created_at + - name: filter[organization_status_id] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + - name: filter[created_at] in: query description: The specified string must be a date range and comma-separated as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` @@ -4709,7 +5417,7 @@ paths: required: false schema: type: string - - name: filter.updated_at + - name: filter[updated_at] in: query description: The specified string must be a date range and comma-separated as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` @@ -4718,38 +5426,38 @@ paths: required: false schema: type: string - - name: filter.my_glue_account_id + - name: filter[my_glue_account_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.group_id + - name: filter[group_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.primary + - name: filter[primary] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.exclude + - name: filter[exclude] in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -4757,31 +5465,31 @@ paths: required: false schema: type: object - - name: filter.exclude.id + - name: filter[exclude][id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.exclude.name + - name: filter[exclude][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.exclude.organization_type_id + - name: filter[exclude][organization_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.exclude.organization_status_id + - name: filter[exclude][organization_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.range + - name: filter[range] in: query description: "To filter on a specific range, supply two comma-separated values\ \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ @@ -4792,38 +5500,18 @@ paths: required: false schema: type: object - - name: filter.range.my_glue_account_id + - name: filter[range][my_glue_account_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,updated_at,organization_status_name,organization_type_name,created_at,short_name,my_glue_account_id.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,attachments,rmm_companies.Metadata:Param @@ -4854,67 +5542,67 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:organizations. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.alert + - name: data[attributes][alert] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.description + - name: data[attributes][description] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.organization_type_id + - name: data[attributes][organization_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_status_id + - name: data[attributes][organization_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.quick_notes + - name: data[attributes][quick_notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.short_name + - name: data[attributes][short_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.parent_id + - name: data[attributes][parent_id] in: query description: Validations:Must be a number. required: false @@ -4952,7 +5640,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Corganizationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -4960,19 +5648,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:organizations. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -4986,31 +5674,31 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_type_id + - name: filter[organization_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_status_id + - name: filter[organization_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.created_at + - name: filter[created_at] in: query description: The specified string must be a date range and comma-separated as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` @@ -5019,7 +5707,7 @@ paths: required: false schema: type: string - - name: filter.updated_at + - name: filter[updated_at] in: query description: The specified string must be a date range and comma-separated as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` @@ -5028,38 +5716,38 @@ paths: required: false schema: type: string - - name: filter.my_glue_account_id + - name: filter[my_glue_account_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.group_id + - name: filter[group_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.primary + - name: filter[primary] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.exclude + - name: filter[exclude] in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -5067,25 +5755,25 @@ paths: required: false schema: type: object - - name: filter.exclude.id + - name: filter[exclude][id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.exclude.name + - name: filter[exclude][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.exclude.organization_type_id + - name: filter[exclude][organization_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.exclude.organization_status_id + - name: filter[exclude][organization_status_id] in: query description: Validations:Must be a number. required: false @@ -5113,7 +5801,11 @@ paths: /organizations/{id}: get: summary: '' - description: Returns the details of an existing organization. + description: 'Returns the details of an existing organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -5121,6 +5813,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:adapters_resources,attachments,rmm_companies.Metadata:Param @@ -5163,7 +5876,7 @@ paths: required: false schema: type: object - - name: filter.type + - name: filter[type] in: query description: Validations:Must be one of:stale,not_viewed,expired. required: false @@ -5178,7 +5891,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cdocumentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -5186,25 +5899,25 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:documents. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data._.attributes.archived + - name: data[_][attributes][archived] in: query description: Validations:Must be one of:true,false. required: true @@ -5222,8 +5935,12 @@ paths: /organizations/{organization_id}/relationships/configurations: get: summary: '' - description: Returns a list of configurations for all organizations or for a - specified organization. + description: 'Returns a list of configurations for all organizations or for + a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -5234,6 +5951,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -5242,118 +5981,98 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_type_id + - name: filter[configuration_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_status_id + - name: filter[configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.contact_id + - name: filter[contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.serial_number + - name: filter[serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.mac_address + - name: filter[mac_address] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.asset_tag + - name: filter[asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.rmm_id + - name: filter[rmm_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for rmm_integration_type' required: false schema: type: string - - name: filter.rmm_integration_type + - name: filter[rmm_integration_type] in: query description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,passwords,attachments,tickets,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -5395,208 +6114,208 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:configurations. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.configuration_type_id + - name: data[attributes][configuration_type_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.configuration_status_id + - name: data[attributes][configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.location_id + - name: data[attributes][location_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.contact_id + - name: data[attributes][contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.manufacturer_id + - name: data[attributes][manufacturer_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.model_id + - name: data[attributes][model_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.operating_system_id + - name: data[attributes][operating_system_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.operating_system_notes + - name: data[attributes][operating_system_notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.hostname + - name: data[attributes][hostname] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.primary_ip + - name: data[attributes][primary_ip] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.attributes.mac_address + - name: data[attributes][mac_address] in: query description: 17 Character limitValidations:Must be a String required: false schema: type: string - - name: data.attributes.default_gateway + - name: data[attributes][default_gateway] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.serial_number + - name: data[attributes][serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.asset_tag + - name: data[attributes][asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.position + - name: data[attributes][position] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.installed_by + - name: data[attributes][installed_by] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.purchased_by + - name: data[attributes][purchased_by] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.purchased_at + - name: data[attributes][purchased_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.warranty_expires_at + - name: data[attributes][warranty_expires_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.mitp_device_expiration_date + - name: data[attributes][mitp_device_expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.mitp_end_of_life_date + - name: data[attributes][mitp_end_of_life_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.installed_at + - name: data[attributes][installed_at] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships + - name: data[relationships] in: query description: Not permitted in PUT/PATCH, optional in POSTValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces + - name: data[relationships][configuration_interfaces] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces.data + - name: data[relationships][configuration_interfaces][data] in: query description: Can contain multiple InterfacesValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._ + - name: data[relationships][configuration_interfaces][data][_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cconfiguration_interfacesâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D.â\x80\ @@ -5604,43 +6323,43 @@ paths: required: false schema: type: object - - name: data.relationships.configuration_interfaces.data._.type + - name: data[relationships][configuration_interfaces][data][_][type] in: query description: Validations:Must be one of:configuration_interfaces. required: true schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes + - name: data[relationships][configuration_interfaces][data][_][attributes] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.configuration_interfaces.data._.attributes.name + - name: data[relationships][configuration_interfaces][data][_][attributes][name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.ip_address + - name: data[relationships][configuration_interfaces][data][_][attributes][ip_address] in: query description: IP4 and IP6 are supportedValidations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.mac_address + - name: data[relationships][configuration_interfaces][data][_][attributes][mac_address] in: query description: Must be a valid MAC addressValidations:Must be a String required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.primary + - name: data[relationships][configuration_interfaces][data][_][attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.relationships.configuration_interfaces.data._.attributes.notes + - name: data[relationships][configuration_interfaces][data][_][attributes][notes] in: query description: Validations:Must be a String required: false @@ -5683,7 +6402,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cconfigurationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -5691,19 +6410,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:configurations. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -5717,87 +6436,87 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_type_id + - name: filter[configuration_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.configuration_status_id + - name: filter[configuration_status_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.contact_id + - name: filter[contact_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.serial_number + - name: filter[serial_number] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.mac_address + - name: filter[mac_address] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.asset_tag + - name: filter[asset_tag] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: filter.rmm_id + - name: filter[rmm_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for rmm_integration_type' required: false schema: type: string - - name: filter.rmm_integration_type + - name: filter[rmm_integration_type] in: query description: Validations:Must be one of:addigy,aem,atera,auvik,managed-workplace,continuum,jamf-pro,kaseya-vsa,automate,log-me-in,msp-rmm,meraki,msp-n-central,ninja-rmm,panorama9,pulseway-rmm,syncro,watchman-monitoring,office365,vsa-x. required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -5825,7 +6544,11 @@ paths: /organizations/{organization_id}/relationships/configurations/{id}: get: summary: '' - description: Returns the details of an existing configuration. + description: 'Returns the details of an existing configuration. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -5842,6 +6565,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:adapters_resources,configuration_interfaces,rmm_records,rmm_adapters_resources,passwords,attachments,tickets,adapters_resources_errors,rmm_adapters_resources_errors,active_network_glue_network_devices,to_configuration_connections,from_configuration_connections,dnet_fa_remote_assets,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param @@ -5867,8 +6611,12 @@ paths: /organizations/{organization_id}/relationships/contacts: get: summary: '' - description: Returns a list of contacts for all organizations or for a specified + description: 'Returns a list of contacts for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -5879,6 +6627,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -5887,93 +6657,73 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.first_name + - name: filter[first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.last_name + - name: filter[last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.title + - name: filter[title] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.contact_type_id + - name: filter[contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.important + - name: filter[important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: filter.primary_email + - name: filter[primary_email] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:first_name,last_name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -6016,87 +6766,87 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:contacts. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.contact_type_id + - name: data[attributes][contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.location_id + - name: data[attributes][location_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.first_name + - name: data[attributes][first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.last_name + - name: data[attributes][last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.title + - name: data[attributes][title] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.important + - name: data[attributes][important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.contact_emails + - name: data[contact_emails] in: query description: Can contain multiple emailsValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.contact_emails._ + - name: data[contact_emails][_] in: query description: "Nameless hash, should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ \x9Cemail@company.comâ\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ @@ -6104,32 +6854,32 @@ paths: required: false schema: type: object - - name: data.contact_emails._.value + - name: data[contact_emails][_][value] in: query description: Must be a valid email address formatValidations:Must be a String required: true schema: type: string - - name: data.contact_emails._.label_name + - name: data[contact_emails][_][label_name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.contact_emails._.primary + - name: data[contact_emails][_][primary] in: query description: Defaults to false if not provided.Validations:Must be one of:true,false. required: false schema: type: string - - name: data.contact_phones + - name: data[contact_phones] in: query description: Can contain multiple phonesValidations:Must be an Array of nested elements required: false schema: type: string - - name: data.contact_phones._ + - name: data[contact_phones][_] in: query description: "Nameless hash: should look like: {â\x80\x9Cvalueâ\x80\x9D: â\x80\ \x9C2341112233â\x80\x9D, â\x80\x9Cprimaryâ\x80\x9D: true, â\x80¦}Validations:Must\ @@ -6137,33 +6887,33 @@ paths: required: false schema: type: object - - name: data.contact_phones._.value + - name: data[contact_phones][_][value] in: query description: Phone numbers are stripped of all separators.Validations:Must be a String required: true schema: type: string - - name: data.contact_phones._.label_name + - name: data[contact_phones][_][label_name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.contact_phones._.extension + - name: data[contact_phones][_][extension] in: query description: Phone extensions are stripped of all separators.Validations:Must be a String required: false schema: type: string - - name: data.contact_phones._.primary + - name: data[contact_phones][_][primary] in: query description: Defaults to false if not provided.Validations:Must be one of:true,false. required: false schema: type: string - - name: data.contact_phones._.label_type + - name: data[contact_phones][_][label_type] in: query description: Defaults to phone if not provided.Validations:Must be one of:phone,fax. required: false @@ -6211,7 +6961,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Ccontactsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -6219,19 +6969,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:contacts. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -6245,62 +6995,62 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.first_name + - name: filter[first_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.last_name + - name: filter[last_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.title + - name: filter[title] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.contact_type_id + - name: filter[contact_type_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.important + - name: filter[important] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: filter.primary_email + - name: filter[primary_email] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false @@ -6328,7 +7078,11 @@ paths: /organizations/{organization_id}/relationships/contacts/{id}: get: summary: '' - description: Returns the details of an existing contact. + description: 'Returns the details of an existing contact. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6345,6 +7099,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:adapters_resources,location,passwords,attachments,tickets,distinct_remote_contacts,resource_fields,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param @@ -6370,8 +7145,12 @@ paths: /organizations/{organization_id}/relationships/domains: get: summary: '' - description: Returns a list of domains for all organizations or for a specified + description: 'Returns a list of domains for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6382,26 +7161,20 @@ paths: required: true schema: type: integer - - name: filter - in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' - required: false - schema: - type: object - - name: filter.id + - name: page[size] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + maximum: 1000 + - name: page[number] in: query description: Validations:Must be a number. required: false schema: type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:created_at,updated_at.Metadata:Param\ @@ -6410,24 +7183,32 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: page.size + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer + - name: page + in: query + description: 'Validations:Must be a HashMetadata:Param Type: CGI' + required: false + schema: + type: object - name: include in: query description: 'Validations:Must be one of:passwords,attachments,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -6451,8 +7232,12 @@ paths: /organizations/{organization_id}/relationships/expirations: get: summary: '' - description: Returns a list of expirations for all organizations or for a specified + description: 'Returns a list of expirations for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6463,6 +7248,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -6471,49 +7278,49 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.resource_id + - name: filter[resource_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.resource_name + - name: filter[resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.resource_type_name + - name: filter[resource_type_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.description + - name: filter[description] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.expiration_date + - name: filter[expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.range + - name: filter[range] in: query description: "To filter on a specific range, supply two comma-separated values\ \ (e.g. â\x80\x9C2, 10â\x80\x9D is filtering for all that are greater than\ @@ -6524,38 +7331,18 @@ paths: required: false schema: type: object - - name: filter.range.expiration_date + - name: filter[range][expiration_date] in: query description: Validations:Must be a String required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:id,organization_id,expiration_date,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -6570,8 +7357,12 @@ paths: /organizations/{organization_id}/relationships/expirations/{id}: get: summary: '' - description: Returns a single expiration with the given ID or a single expiration + description: 'Returns a single expiration with the given ID or a single expiration for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6588,6 +7379,27 @@ paths: required: true schema: type: string + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -6618,43 +7430,43 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:flexible_assets. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.flexible_asset_type_id + - name: data[attributes][flexible_asset_type_id] in: query description: Validations:Must be a number. required: true schema: type: integer - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.traits + - name: data[attributes][traits] in: query description: A hash of key value pairs for the traits of this asset. Values can be arrays. The key has to be an available field key from the specified @@ -6684,8 +7496,12 @@ paths: /organizations/{organization_id}/relationships/locations: get: summary: '' - description: Returns a list of locations for all organizations or for a specified + description: 'Returns a list of locations for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6696,6 +7512,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -6704,81 +7542,61 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.city + - name: filter[city] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.region_id + - name: filter[region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,id,primary,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -6823,98 +7641,98 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:locations. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.primary + - name: data[attributes][primary] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.address_1 + - name: data[attributes][address_1] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.address_2 + - name: data[attributes][address_2] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.city + - name: data[attributes][city] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.postal_code + - name: data[attributes][postal_code] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.region_id + - name: data[attributes][region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.country_id + - name: data[attributes][country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.phone + - name: data[attributes][phone] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.fax + - name: data[attributes][fax] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -6942,7 +7760,11 @@ paths: /organizations/{organization_id}/relationships/locations/{id}: get: summary: '' - description: Returns the details of an existing location. + description: 'Returns the details of an existing location. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -6959,6 +7781,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:adapters_resources,attachments,passwords,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param @@ -7007,7 +7850,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Clocationsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -7015,19 +7858,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:locations. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -7041,50 +7884,50 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.city + - name: filter[city] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.region_id + - name: filter[region_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.psa_id + - name: filter[psa_id] in: query description: 'Validations:Must be a StringMetadata:Notes: This must be accompanied by the filter for psa_integration_type' required: false schema: type: string - - name: filter.psa_integration_type + - name: filter[psa_integration_type] in: query description: Validations:Must be one of:manage,autotask,tigerpaw,kaseya-bms,pulseway-psa,vorex. required: false @@ -7112,8 +7955,12 @@ paths: /organizations/{organization_id}/relationships/passwords: get: summary: '' - description: Returns a list of passwords for all organizations or for a specified + description: 'Returns a list of passwords for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -7124,6 +7971,28 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -7132,74 +8001,54 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.password_category_id + - name: filter[password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.url + - name: filter[url] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.cached_resource_name + - name: filter[cached_resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -7250,69 +8099,69 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:passwords. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.password_category_id + - name: data[attributes][password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.username + - name: data[attributes][username] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.password + - name: data[attributes][password] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.otp_secret + - name: data[attributes][otp_secret] in: query description: One Time Password secretValidations:Must be a String required: false schema: type: string - - name: data.attributes.resource_id + - name: data[attributes][resource_id] in: query description: Must be used together with `resource_type`Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.resource_type + - name: data[attributes][resource_type] in: query description: Must be used together with `resource_id`Validations:Must be one of:Configuration,Contact,Document,Domain,Location,SSL Certificate,Flexible @@ -7320,51 +8169,51 @@ paths: required: false schema: type: string - - name: data.attributes.url + - name: data[attributes][url] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.password_updated_at + - name: data[attributes][password_updated_at] in: query description: Date the password last changedValidations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.autofill_selectors + - name: data[attributes][autofill_selectors] in: query description: Used for identification of fields for password autofillValidations:Must be a String required: false schema: type: string - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.is_live + - name: data[attributes][is_live] in: query description: Used for understanding - is this a live version of the password or not.Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.generated_password_type + - name: data[attributes][generated_password_type] in: query description: This value indicates if the user is using the complex password feature, and if the password is complex or pronounceable.Validations:Must @@ -7372,44 +8221,44 @@ paths: required: false schema: type: string - - name: data.relationships + - name: data[relationships] in: query description: Not permitted in PUT/PATCH, optional in POSTValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category + - name: data[relationships][password_category] in: query description: Can belong to one password categoryValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category.data + - name: data[relationships][password_category][data] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category.data.type + - name: data[relationships][password_category][data][type] in: query description: Validations:Must be one of:password-categories. required: true schema: type: string - - name: data.relationships.password_category.data.attributes + - name: data[relationships][password_category][data][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.relationships.password_category.data.attributes.name + - name: data[relationships][password_category][data][attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.relationships.password_category.data.attributes.account_id + - name: data[relationships][password_category][data][attributes][account_id] in: query description: Identifies the account that this category belongs to.Validations:Must be a number. @@ -7438,7 +8287,11 @@ paths: /organizations/{organization_id}/relationships/passwords/{id}: get: summary: '' - description: Returns the details of an existing password. + description: 'Returns the details of an existing password. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: organization_id in: path @@ -7455,6 +8308,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: include in: query description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses,recent_versions,related_items,authorized_users.Metadata:Param @@ -7521,7 +8395,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cpasswordsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -7529,19 +8403,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:passwords. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -7555,43 +8429,43 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.password_category_id + - name: filter[password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.url + - name: filter[url] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.cached_resource_name + - name: filter[cached_resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -7619,22 +8493,26 @@ paths: /password_categories: get: summary: '' - description: Returns a list of password categories in your account. + description: 'Returns a list of password categories in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: Validations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,created_at,updated_at.Metadata:Param\ @@ -7643,24 +8521,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: Validations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -7683,19 +8563,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:password_categories. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true @@ -7721,7 +8601,11 @@ paths: /password_categories/{id}: get: summary: '' - description: Returns the details of an existing password category. + description: 'Returns the details of an existing password category. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -7729,6 +8613,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -7745,9 +8650,35 @@ paths: /passwords: get: summary: '' - description: Returns a list of passwords for all organizations or for a specified + description: 'Returns a list of passwords for all organizations or for a specified organization. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -7765,74 +8696,54 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.password_category_id + - name: filter[password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.url + - name: filter[url] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.cached_resource_name + - name: filter[cached_resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:name,username,url,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - name: include in: query description: 'Validations:Must be one of:network_glue_networks,attachments,rotatable_password,updater,user_resource_accesses,group_resource_accesses.Metadata:Param @@ -7883,69 +8794,69 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:passwords. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: Required identifier for bulk updatesValidations:Must be a number. required: false schema: type: integer - - name: data.attributes.organization_id + - name: data[attributes][organization_id] in: query description: Not required when using nested relationship routesValidations:Must be a number. required: true schema: type: integer - - name: data.attributes.password_category_id + - name: data[attributes][password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.name + - name: data[attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.username + - name: data[attributes][username] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.password + - name: data[attributes][password] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.otp_secret + - name: data[attributes][otp_secret] in: query description: One Time Password secretValidations:Must be a String required: false schema: type: string - - name: data.attributes.resource_id + - name: data[attributes][resource_id] in: query description: Must be used together with `resource_type`Validations:Must be a number. required: false schema: type: integer - - name: data.attributes.resource_type + - name: data[attributes][resource_type] in: query description: Must be used together with `resource_id`Validations:Must be one of:Configuration,Contact,Document,Domain,Location,SSL Certificate,Flexible @@ -7953,51 +8864,51 @@ paths: required: false schema: type: string - - name: data.attributes.url + - name: data[attributes][url] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.password_updated_at + - name: data[attributes][password_updated_at] in: query description: Date the password last changedValidations:Must be a String required: false schema: type: string - - name: data.attributes.restricted + - name: data[attributes][restricted] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.autofill_selectors + - name: data[attributes][autofill_selectors] in: query description: Used for identification of fields for password autofillValidations:Must be a String required: false schema: type: string - - name: data.attributes.archived + - name: data[attributes][archived] in: query description: Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.is_live + - name: data[attributes][is_live] in: query description: Used for understanding - is this a live version of the password or not.Validations:Must be one of:true,false,1,0. required: false schema: type: string - - name: data.attributes.generated_password_type + - name: data[attributes][generated_password_type] in: query description: This value indicates if the user is using the complex password feature, and if the password is complex or pronounceable.Validations:Must @@ -8005,44 +8916,44 @@ paths: required: false schema: type: string - - name: data.relationships + - name: data[relationships] in: query description: Not permitted in PUT/PATCH, optional in POSTValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category + - name: data[relationships][password_category] in: query description: Can belong to one password categoryValidations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category.data + - name: data[relationships][password_category][data] in: query description: Validations:Must be a Hash required: false schema: type: object - - name: data.relationships.password_category.data.type + - name: data[relationships][password_category][data][type] in: query description: Validations:Must be one of:password-categories. required: true schema: type: string - - name: data.relationships.password_category.data.attributes + - name: data[relationships][password_category][data][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.relationships.password_category.data.attributes.name + - name: data[relationships][password_category][data][attributes][name] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.relationships.password_category.data.attributes.account_id + - name: data[relationships][password_category][data][attributes][account_id] in: query description: Identifies the account that this category belongs to.Validations:Must be a number. @@ -8091,7 +9002,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cpasswordsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -8099,19 +9010,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:passwords. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -8125,43 +9036,43 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.password_category_id + - name: filter[password_category_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.url + - name: filter[url] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.cached_resource_name + - name: filter[cached_resource_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.archived + - name: filter[archived] in: query description: Validations:Must be one of:true,false,1,0. required: false @@ -8189,7 +9100,11 @@ paths: /passwords/{id}: get: summary: '' - description: Returns the details of an existing password. + description: 'Returns the details of an existing password. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -8197,6 +9112,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: organization_id in: query description: 'Only required for nested relationships routeValidations:Must @@ -8270,22 +9206,26 @@ paths: /platforms: get: summary: '' - description: Returns a list of supported platforms. + description: 'Returns a list of supported platforms. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - - name: filter + - name: page[size] in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI - - Notes: Comma separated values' + description: Validations:Must be a number. required: false schema: - type: object - - name: filter.name + type: integer + maximum: 1000 + - name: page[number] in: query - description: exact match onlyValidations:Must be a String + description: Validations:Must be a number. required: false schema: - type: string + type: integer + minimum: 1 - name: sort in: query description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ @@ -8294,24 +9234,26 @@ paths: required: false schema: type: string - - name: page + - name: filter in: query - description: 'Validations:Must be a HashMetadata:Param Type: CGI' + description: 'Validations:Must be a HashMetadata:Param Type: CGI + + Notes: Comma separated values' required: false schema: type: object - - name: page.number + - name: filter[name] in: query - description: Validations:Must be a number. + description: exact match onlyValidations:Must be a String required: false schema: - type: integer - - name: page.size + type: string + - name: page in: query - description: Validations:Must be a number. + description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: - type: integer + type: object responses: '200': description: Successful response @@ -8326,7 +9268,11 @@ paths: /platforms/{id}: get: summary: '' - description: Returns details of one of the supported platforms. + description: 'Returns details of one of the supported platforms. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -8334,6 +9280,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -8350,8 +9317,34 @@ paths: /regions: get: summary: '' - description: Returns a list of supported regions. + description: 'Returns a list of supported regions. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: country_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -8369,50 +9362,30 @@ paths: required: false schema: type: object - - name: filter.name + - name: filter[name] in: query description: exact match onlyValidations:Must be a String required: false schema: type: string - - name: filter.iso + - name: filter[iso] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.country_id + - name: filter[country_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -8427,7 +9400,11 @@ paths: /regions/{id}: get: summary: '' - description: Returns the details of one of the supported regions. + description: 'Returns the details of one of the supported regions. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -8435,6 +9412,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string - name: country_id in: query description: 'Only required for nested relationships route.Validations:Must @@ -8460,8 +9458,34 @@ paths: /user_metrics: get: summary: '' - description: Returns a list of the user metrics in your account. + description: 'Returns a list of the user metrics in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:id,created,viewed,edited,deleted,date.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -8470,25 +9494,25 @@ paths: required: false schema: type: object - - name: filter.user_id + - name: filter[user_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.organization_id + - name: filter[organization_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.resource_type + - name: filter[resource_type] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.date + - name: filter[date] in: query description: The specified string must be a date range and comma-separated as `start_date, end_date`. The dates are UTC. Use `*` for unspecified `start_date` @@ -8497,32 +9521,12 @@ paths: required: false schema: type: string - - name: sort - in: query - description: "Validations:Must be one of:id,created,viewed,edited,deleted,date.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -8537,8 +9541,34 @@ paths: /users: get: summary: '' - description: Returns a list of the users in your account. + description: 'Returns a list of the users in your account. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: + - name: page[size] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Validations:Must be a number. + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: "Validations:Must be one of:name,email,reputation,id,created_at,updated_at.Metadata:Param\ + \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ + \ values" + required: false + schema: + type: string - name: filter in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI @@ -8547,62 +9577,42 @@ paths: required: false schema: type: object - - name: filter.id + - name: filter[id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: filter.name + - name: filter[name] in: query description: exact match onlyValidations:Must be a String required: false schema: type: string - - name: filter.email + - name: filter[email] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.role_name + - name: filter[role_name] in: query description: Validations:Must be a String required: false schema: type: string - - name: filter.salesforce_id + - name: filter[salesforce_id] in: query description: Validations:Must be a number. required: false schema: type: integer - - name: sort - in: query - description: "Validations:Must be one of:name,email,reputation,id,created_at,updated_at.Metadata:Param\ - \ Type: CGI\nNotes: |\n To Invert order use -, eg: -name\n Comma separated\ - \ values" - required: false - schema: - type: string - name: page in: query description: 'Validations:Must be a HashMetadata:Param Type: CGI' required: false schema: type: object - - name: page.number - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer - - name: page.size - in: query - description: Validations:Must be a number. - required: false - schema: - type: integer responses: '200': description: Successful response @@ -8617,7 +9627,11 @@ paths: /users/{id}: get: summary: '' - description: Returns information about one user. + description: 'Returns information about one user. + + + Note: The maximum number of results that can be requested is 1000. If your + requests are timing out, try lowering the page size.' parameters: - name: id in: path @@ -8625,6 +9639,27 @@ paths: required: true schema: type: integer + - name: page[size] + in: query + description: Number of items per page (max 1000) + required: false + schema: + type: integer + maximum: 1000 + - name: page[number] + in: query + description: Page number to retrieve + required: false + schema: + type: integer + minimum: 1 + - name: sort + in: query + description: Field by which to sort the results. Prepend '-' for descending + order. + required: false + schema: + type: string responses: '200': description: Successful response @@ -8666,19 +9701,19 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:attachments. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.attachment + - name: data[attributes][attachment] in: query description: "Can be an uploaded file if multipart is used, or a JSON with\ \ Base64 encoded content as following:\"attachment\"\ @@ -8735,7 +9770,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Cattachmentsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -8743,19 +9778,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:attachments. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true @@ -8807,25 +9842,25 @@ paths: required: true schema: type: object - - name: data.type + - name: data[type] in: query description: Validations:Must be one of:related_items. required: true schema: type: string - - name: data.attributes + - name: data[attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data.attributes.id + - name: data[attributes][id] in: query description: 'Validations:Must be a number.Metadata:Param Type: In URL' required: true schema: type: integer - - name: data.attributes.destination_type + - name: data[attributes][destination_type] in: query description: Validations:Must be one of:User,Checklist,Checklist Template,Contact,Configuration,Datto Device,Document,Document Folder,Domain,Location,Organization,Password,SSL @@ -8833,19 +9868,19 @@ paths: required: true schema: type: string - - name: data.attributes.destination_id + - name: data[attributes][destination_id] in: query description: Validations:Must be a String required: true schema: type: string - - name: data.attributes.notes + - name: data[attributes][notes] in: query description: Validations:Must be a String required: false schema: type: string - - name: data.attributes.via_copilot + - name: data[attributes][via_copilot] in: query description: Validations:Must be a String required: false @@ -8899,7 +9934,7 @@ paths: required: true schema: type: string - - name: data._ + - name: data[_] in: query description: "Nameless hash: should look like: {â\x80\x9Ctypeâ\x80\x9D: â\x80\ \x9Crelated_itemsâ\x80\x9D, â\x80\x9Cattributesâ\x80\x9D:â\x80¦}Validations:Must\ @@ -8907,19 +9942,19 @@ paths: required: false schema: type: object - - name: data._.type + - name: data[_][type] in: query description: Validations:Must be one of:related_items. required: true schema: type: string - - name: data._.attributes + - name: data[_][attributes] in: query description: Validations:Must be a Hash required: true schema: type: object - - name: data._.attributes.id + - name: data[_][attributes][id] in: query description: Validations:Must be a number. required: true